README

RPGFaker 是一个库，可以生成您在奇幻游戏/小说/任何其他内容中使用的名称。要将 RPGFaker 添加到您的项目中，只需运行

composer require andreasindal/rpgfaker

使用方法

<?php

use RPGFaker\RPGFaker;

$faker = new RPGFaker();
echo $faker->name;
echo $faker->town;

// Rildess Fazhria
// Northfall

名称

RPGFaker 可以为您生成角色名称。以下是您可以传递给 RPGFaker 的选项，让您自定义生成的名称。

选项

当实例化 RPGFaker 对象时，您可以提供一个选项数组。默认值为

$faker = new RPGFaker([
    'race'          => null,
    'length'        => 2,
    'count'         => 2,
    'special'       => 'random',
    'duplicates'    => [true, 5],
]);

种族（字符串）

race 选项允许您提供奇幻种族的名称，生成的名称将很好地符合该种族。以下是与种族相关的名称示例

Elf:        Dessiell Rianahr
Human:      Cynwin Whiteley
Orc/Troll:  Voshyzh Roshzak

当前接受的种族有 elf、human、orc 和 troll（orc 和 troll 使用相同的设置）。如果提供 null 或任何其他种族，则将使用所有种族的设置。

长度（整数|数组）

length 选项定义了生成的名称将有多少个音节*。例如，长度为 2 可能会生成一个名为 "Cynwin" 的名称，而长度为 3 可能会生成一个名为 "Fazhtargmoh" 的名称。长度选项也可以是一个整数数组，如果是，则必须包含与 "count" 选项（见下文）数量相同的元素。如果提供的长度是数组，则每个元素指定每个名称的音节数。但是，当生成一个 特殊姓氏 时，不考虑长度参数。

示例

<?php

use RPGFaker\RPGFaker;

$faker = new RPGFaker([
    'length' => [1, 2, 3],
    'count'  => 3
]);
echo $faker->name;

// example output: Varr Iennahr Cynsadorf

* 在某些情况下，RPGFaker 认为一个音节可能实际上是两个音节，例如 "fara"。

数量（整数）

count 只是定义了应该生成的名称数量。默认值是 2。

示例

<?php

use RPGFaker\RPGFaker;

$faker = new RPGFaker([
    'count'  => 1
]);
echo $faker->name;

// example output: Wogien

$faker->setOptions([
    'count'  => 3
]);
echo $faker->name;

// example output: Steinril Annton Saeith

特殊（布尔值|字符串）

special 可以设置为字符串 'random'、true 或 false。特殊定义是否使用特殊姓氏。

示例

<?php

use RPGFaker\RPGFaker;

$faker = new RPGFaker([
    'special' => true
]);
echo $faker->name;

// example output: Dirwog Greenhorn

$faker->setOptions([
    'special' => false
]);
echo $faker->name;

// example output: Annlor Makceh

重复（数组）

重复选项的第一个元素指定是否允许重复，第二个元素指定如果发生重复应尝试的次数。重复标志控制名称的所有部分，即，在生成 Rileith Doreith 之后 Rileith Starcleaver 将尝试重试。

此设置在生成大量名称时可能特别有用。

城镇

RPGFaker 还可以为您生成城镇名称。城镇名称生成器唯一的选项是 duplicates 选项，该选项在此处 描述。

许可证

MIT。