Skip to content

Commit

Permalink
[pre-commit.ci] auto fixes from pre-commit.com hooks
Browse files Browse the repository at this point in the history
for more information, see https://pre-commit.ci
  • Loading branch information
pre-commit-ci[bot] committed Nov 23, 2023
1 parent cdee3c7 commit 1097eaa
Show file tree
Hide file tree
Showing 2 changed files with 29 additions and 29 deletions.
2 changes: 1 addition & 1 deletion devel/.env
Original file line number Diff line number Diff line change
@@ -1 +1 @@
OPENAI_API_KEY=''
OPENAI_API_KEY=''
56 changes: 28 additions & 28 deletions docs/markdown.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ For units, the script retrieves:
#. Name, race, age, profession
#. Description from the Unit/Health/Description screen
#. Traits from the Unit/Personality/Traits screen
The script works for all units with text in the Description &/or Personality/Traits tabs,
The script works for all units with text in the Description &/or Personality/Traits tabs,
such as dwarves, dogs, elves, goblins, and beasts.

For items, it retrieves:
Expand All @@ -21,10 +21,10 @@ For items, it retrieves:
The script works for most items with in-game descriptions and names, including those in storage,
on the ground, installed as a building, or worn/carried by units.

The script appends a markdown-formatted version of the text to a target file
The script appends a markdown-formatted version of the text to a target file
for easy sharing, e.g., on Reddit.

By default, entries are appended, not overwritten, allowing the ``markdown`` command
By default, entries are appended, not overwritten, allowing the ``markdown`` command
to compile descriptions of multiple items & units in a single document.

By default, data is stored in markdown_{YourWorldName}_export.md.
Expand All @@ -39,8 +39,8 @@ Usage

markdown [-o] [<filename>]

Appends the description of the selected unit/item
to ``markdown_{world_name}_export.md`` file by default.
Appends the description of the selected unit/item
to ``markdown_{world_name}_export.md`` file by default.
Specifying a filename will append to ``markdown_{filename}.md`` instead,
which is useful for organizing data by category or topic.
The [-o] argument tells the script to overwrite the output file.
Expand All @@ -50,7 +50,7 @@ Options

``-o``
Overwrite the output file, deleting previous entries.
``help``
``help``
Show help.

Examples
Expand All @@ -66,42 +66,42 @@ Example output for a selected chalk statue in the world "Orid Tamun", appended t

### ☼Chalk Statue of Bìlalo Bandbeach☼

#### Description:
This is a well-crafted chalk statue of Bìlalo Bandbeach. The item is an image of
Bìlalo Bandbeach the elf and Lani Lyricmonks the Learned the ettin in chalk by
Domas Uthmiklikot. Lani Lyricmonks the Learned is striking down Bìlalo Bandbeach.
The artwork relates to the killing of the elf Bìlalo Bandbeach by the
ettin Lani Lyricmonks the Learned with Hailbite in The Forest of Indignation in 147.
#### Description:
This is a well-crafted chalk statue of Bìlalo Bandbeach. The item is an image of
Bìlalo Bandbeach the elf and Lani Lyricmonks the Learned the ettin in chalk by
Domas Uthmiklikot. Lani Lyricmonks the Learned is striking down Bìlalo Bandbeach.
The artwork relates to the killing of the elf Bìlalo Bandbeach by the
ettin Lani Lyricmonks the Learned with Hailbite in The Forest of Indignation in 147.

---
::

``markdown -o descriptions``

Example output for a selected unit Lokum Alnisendok, written to the newly overwritten ``markdown_descriptions.md`` file:
::

### Lokum Alnisendok, dwarf, 27 years old Presser.

#### Description:
#### Description:
A short, sturdy creature fond of drink and industry.

He is very quick to tire.
He is very quick to tire.

His very long beard is neatly combed. His very long sideburns are braided.
His very long moustache is neatly combed. His hair is clean-shaven. He is average in size.
His nose is sharply hooked. His nose bridge is convex. His gold eyes are slightly wide-set.
His somewhat tall ears are somewhat narrow. His hair is copper. His skin is copper.
His very long beard is neatly combed. His very long sideburns are braided.
His very long moustache is neatly combed. His hair is clean-shaven. He is average in size.
His nose is sharply hooked. His nose bridge is convex. His gold eyes are slightly wide-set.
His somewhat tall ears are somewhat narrow. His hair is copper. His skin is copper.

#### Personality:
He has an amazing memory, but he has a questionable spatial sense and poor focus.
#### Personality:
He has an amazing memory, but he has a questionable spatial sense and poor focus.

He doesn't generally think before acting. He feels a strong need to reciprocate any favor done for him.
He enjoys the company of others. He does not easily hate or develop negative feelings. He generally
finds himself quite hopeful about the future. He tends to be swayed by the emotions of others.
He finds obligations confining, though he is conflicted by this for more than one reason. He doesn't
tend to hold on to grievances. He has an active imagination.
He doesn't generally think before acting. He feels a strong need to reciprocate any favor done for him.
He enjoys the company of others. He does not easily hate or develop negative feelings. He generally
finds himself quite hopeful about the future. He tends to be swayed by the emotions of others.
He finds obligations confining, though he is conflicted by this for more than one reason. He doesn't
tend to hold on to grievances. He has an active imagination.

He needs alcohol to get through the working day.
He needs alcohol to get through the working day.

---
---

0 comments on commit 1097eaa

Please sign in to comment.