mimic-tools / name-generation Goto Github PK

Create a file in name-generation/tree/main/name-segments/adjectives/ called "tundra.txt"
Fill it with some adjectives relating to desert dwellers. The context of this is for building surnames e.g. "Cosmic Trueaxe", so bear this in mind

e.g.
Tom Coldshovel
Tom Iceshovel
Tom Frozenshovel

It's okay if we have duplicate names in different files - the name "John" or "Mary" is common in various regions.
However, we don't want to have the same name in a single file more than once. This will skew randomness checking.

This is particularly important as the name database grows and it's hard to visually check.

Write a python script to check if any of the files in the repo contain a name more than once.

in name-configurations/ there are examples of how names can be structured.

We only have humans and dwarves (barely) at the moment.
It would be great to create additional name types for people to choose from.

If possible, please include example names in name-segments/

Possible examples to do:

• Halflings
• Dragons
• Dragonborn
• Tritons
• Goblins
• Orcs
• Elves
  • High
  • Drow
  • Wood
  • Sea

Task

Please add some more nouns to our environments!

Description

There are several files in name-generation/tree/main/name-segments/nouns/ for different region types. We use these to build names for people from those regions.

The more appropriate words the better. It's important that they are nouns and relevant to the region.

We build names from these lists like "Cosmic Trueaxe", so think about how your word might sound as a name

All that needs to be done is to add as many appropriate words that you can think of at the ends of any of the files.

Good examples for the arctic/tundra:
Tom Coldice
Tom Coldsled
Tom Coldshovel

Bad examples for the arctic/tundra:
Tom Coldfrosty (Adjective, not noun)
Tom Coldresearchstation (very long, two words, modern)
Tom Coldoval (Oval has nothing to do with the arctic/tundra)

Status

See this report for current state of nouns:
https://github.com/Mimic-Tools/name-generation/blob/main/availability_report.csv
Also check out the wiki for regions not yet added
https://github.com/Mimic-Tools/name-generation/wiki

Name segment files are structured as follows (for western names):

name-segments/forename/
  american-female.txt
  american-male.txt
  american.txt (gender neutral names)
name-segments/surname/
  american.txt

There are many missing regions that have not been accounted for yet. Please add them if possible.
Note: If there is a similar category that exists, please use the existing one.

Task

Please add some more adjectives to our air environment!

Description

Create a file in name-generation/tree/main/name-segments/adjectives/ called air.txt if it does not exist. Then, put new adjectives into it, each on a new line.

We will use these to build names for people from those regions.

The more appropriate words the better. It's important that they be adjectives and relevant to the region.

We build names from these lists like "Cosmic Trueaxe", so think about how your word might sound as a name

All that needs to be done is to add as many appropriate words that you can think of at the ends of any of the files.

Good examples for the air:
John Lightfalcon
John Fastfalcon
John Calmfalcon

Bad examples for the arctic/tundra:
John Nestfalcon (Noun, not adjective)
John Hotairballoonfalcon (very long, several words, noun)
John Windyfalcon (this one is fine but as it's based on a noun, we could generate Windywind)
John Ovalfalcon (Oval has nothing to do with the arctic/tundra

• Create a file in name-generation/tree/main/name-segments/nouns called "aquatic.txt"
• Fill it with some water related nouns. The context of this is for building surnames e.g. "Cosmic Trueaxe", so bear this in mind

• Create a file in name-generation/tree/main/name-segments/nouns called "desert.txt"
• Fill it with some desert related nouns. The context of this is for building surnames e.g. "Cosmic Trueaxe", so bear this in mind

Sometimes we'd like to disable a 'bad' name or put in a contextual note.
for example, it might be nice to be able to have a note that says what type of name submissions are requested.

 # This file will be deprecated soon, so you may want to look at other-name.txt to make changes.
 John
 Mary
 Ali

The main thing stopping us having this is the generate.py script. It replaces the strings ["a-file"] with the contents of that file and seperates them with a | charcter.

e.g.
TAG = ["somefile"]
becomes
TAG = John | Mary | Ali
without comments, but if we added it in it would produce
TAG = #This file.... changes. | John | Mary | Ali
Allowing the comment to be selected as a name partial.

We should detect the comment and remove it before adding to the list of possible entries
https://github.com/Mimic-Tools/name-generation/blob/main/generate.py#L7

The Enums in NameBank are based on what files are in name-segments/forenames
https://github.com/Mimic-Tools/name-generation/blob/main/generate.py#L20

It would be nice if we could query this folder to make enums, because then we would pick up any files that people add, lowering the barrier for non-technical entry

You can find these files in (American example):

name-segments/ 
  forename-american-female.txt
  forename-american-male.txt
  surname-american.txt

for gender-neutral names, please place them in a file like forename-american.txt (You may need to create this file)

Create a file in name-generation/tree/main/name-segments/nouns called "forest.txt"
Fill it with some forest related nouns. The context of this is for building fantasy surnames e.g. "Cosmic Trueaxe", so bear this in mind

e.g.
Eve Greenwolf
Eve Greentree
Eve Greenleaf

Write a small python script that will produce a textual report on what files are missing in our repository.
We can then turn these missing files into issues.

It should search for the following files:
(e.g. Mountain)
name-segments/
adjectives/
mountain.txt
nouns/
mountain.txt
postfix/
mountain.txt

Then we can view a report like the following:

You can either use the list here: https://github.com/Mimic-Tools/name-generation/wiki of regions, or only use ones that have existing files (preferred)

particular for Human case

region-checker.py creates a matrix of what files are missing from our name segments.
If we change it to CSV, we'll be able to easily see it in the repo, as github supports displaying the format

Example of github supporting CSV: https://github.com/CSSEGISandData/COVID-19/blob/master/csse_covid_19_data/csse_covid_19_time_series/time_series_covid19_confirmed_global.csv

Additionally, it would nice to have a matching ✗ instead of X for the cells that do not match

• move region-checker.py and name-duplicate-checker.py to a new scripts/ folder
• move availability report to new reports/ folder
• move index.html and css/ folder into webpage/ folder

Ensure scripts still functional.

Create a file in name-generation/tree/main/name-segments/nouns called "urban.txt"
Fill it with some urban/city related nouns. The context of this is for building surnames e.g. "Cosmic Trueaxe", so bear this in mind

e.g.
Eve Blacksmoke
Eve Blackcity
Eve Blackalley

Task

Please add some more adjectives to our environments!

Description

There are several files in name-generation/tree/main/name-segments/adjectives/ for different region types. We use these to build names for people from those regions.

The more appropriate words the better. It's important that they be adjectives and relevant to the region.

We build names from these lists like "Cosmic Trueaxe", so think about how your word might sound as a name

All that needs to be done is to add as many appropriate words that you can think of at the ends of any of the files.

Good examples for the arctic/tundra:
Tom Coldshovel
Tom Iceshovel
Tom Frozenshovel

Bad examples for the arctic/tundra:
Tom Iglooshovel (Noun, not adjective)
Tom Absolutezeroshovel (very long, two words)
Tom Snowyshovel (this one is fine but as it's based on a noun, we could generate Snowysnow)
Tom Ovalshovel (Oval has nothing to do with the arctic/tundra)

Status

See this report for current state of nouns:
https://github.com/Mimic-Tools/name-generation/blob/main/availability_report.csv
Also check out the wiki for regions not yet added
https://github.com/Mimic-Tools/name-generation/wiki

Create a file in name-generation/tree/main/name-segments/nouns called "underground.txt"
Fill it with some underground related nouns. The context of this is for building surnames e.g. "Cosmic Trueaxe", so bear this in mind

e.g.
Nora Darktunnel
Nora Darkspore
Nora Darkhollow

The easiest way to use this tool will be through a webpage.
I have drafted a quick example of the options for configuring a character here:
https://github.com/Mimic-Tools/name-generation/wiki/Character-Creation-Wireboard

Using HTML Forms, Create a webpage that has a form which allows you to select options for a character.

You do not have to write logic to submit the character.

Create a file in name-generation/tree/main/name-segments/adjectives/ called "desert.txt"
Fill it with some adjectives relating to desert dwellers. The context of this is for building surnames e.g. "Cosmic Trueaxe", so bear this in mind

e.g.
Tom Hotsand
Tom Goldsand
Tom Drysand

Create a file in name-generation/tree/main/name-segments/nouns called "tundra.txt"
Fill it with some tundra/arctic related nouns. The context of this is for building surnames e.g. "Cosmic Trueaxe", so bear this in mind

e.g.
John Whitesnow
John Whitepick
John Whitetent