Skip to content

Commit

Permalink
fix: Add a spellcheck and fix various typos (#50)
Browse files Browse the repository at this point in the history
* Create ignore-words.txt

* Create spellcheck.yml

* Update changelog.md

* Update old_CONTRIBUTING.md

* Update cssf cluster.txt

* Update map.txt

* Update pelitol cluster.txt

* Update animeorg anime retrieval.txt

* Update date format.txt

* Update gh codevault.txt

* Update animeorg hails.txt

* Update deprecated.txt

* Update martieu data smuggling.txt

* Update ignore-words.txt

* Update gh codevault.txt

* Update ignore-words.txt

* Update .gitignore

* Update GrowingUp.md
  • Loading branch information
TheGiraffe3 authored Oct 20, 2024
1 parent 84150c0 commit a24431e
Show file tree
Hide file tree
Showing 15 changed files with 45 additions and 18 deletions.
6 changes: 6 additions & 0 deletions .github/workflows/ignore-words.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
Rin
Rouge
ammount
crate
inpt
recieve
21 changes: 21 additions & 0 deletions .github/workflows/spellcheck.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
name: Spell Checking

on: [push, pull_request]

jobs:
codespell:
name: Check spelling with codespell
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Set up Python 3.12
uses: actions/setup-python@v4
with:
python-version: 3.12
- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install codespell
if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
- name: Check spelling with codespell
run: codespell --ignore-words=.github/workflows/ignore-words.txt || exit 1
2 changes: 1 addition & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ __pycache__
#
#===< Whitelist >===#
#
!Wintersconfig.yaml
!Wintersconfig.json
!.git
!.gitignore
!.gitattributes
Expand Down
4 changes: 2 additions & 2 deletions changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@
- Technical writers in human space will now sometimes rant about using the year-month-day format for dates.
- You now have a chance of encountering a man in the spaceport who will rant about the date format. On a loudspeaker.
- Added mission where someone is moving to Asgard and she wants you to transport her stuff. By the way, her landlord is Carla von Hausen.
- After meeting Carla von Hausen during the Skadenga storyline, there is a 5% chance everytime you land on Asgard that she will enter your ship and attempt to sell you a house.
- After meeting Carla von Hausen during the Skadenga storyline, there is a 5% chance every time you land on Asgard that she will enter your ship and attempt to sell you a house.
- Fixed Liz Cheney claiming her "Kestrel was much cooler" when her person ship is a Star Queen.
- Removed Liz Cheney person ship dialog referencing Donald Trump to avoid harassment from Trump supporters. Please, don't get me involved in the mess that is American politics.
- Grammar and typo fixes.
Expand Down Expand Up @@ -259,7 +259,7 @@
- Laateli description had an extra `3` at the end
- Rebalanced Jarkiiens fleets, less CSSF presence
- Added Emeka'a Isai's name to the phrase lists
- For reference, she's that one governer you meet during the
- For reference, she's that one governor you meet during the
Wanderer campaign
- Added a new planet called "Eisei", owned by the Anime Organization
- Added more stuff about the Anime Organization
Expand Down
4 changes: 2 additions & 2 deletions data/cssf cluster.txt
Original file line number Diff line number Diff line change
Expand Up @@ -740,14 +740,14 @@ planet "Liminal Bastion"
planet "Geidontei Fortress"
landscape "land/geidonteiFortress"
government "Yuyuko Saigyouji"
description `The Geidontei Fortress is another massive military base. Military infastructure dominates on this planet, with the sight of civillians very rare. The massive fleet defenses here ensure that any plushie smuggler will have a hard time transporting plushies past this system.`
description `The Geidontei Fortress is another massive military base. Military infastructure dominates on this planet, with the sight of civilians very rare. The massive fleet defenses here ensure that any plushie smuggler will have a hard time transporting plushies past this system.`
spaceport `The spaceport is full of soldiers and large turrets, some of which are pointed at you, ready to fire even on the slightest suspicion that you are carrying plushies. A large incineration facility nearby burns plushies as they are intercepted, polluting the nearby environment and turning the nearby fog grey.`

planet "Nuclear Furnace"
landscape "land/nuclearFurnace"
government "Yuyuko Saigyouji"
description `The Nuclear Furnace, named such due to its proximity to its star and the large radioactive mineral deposits in the crust and mantle, is a critical mining world. Most of the minerals are shipped offworld. There is no need for nuclear power, with solar panels covering up to 50% of the surface.`
spaceport `Large ships continually offload radioactive minerals at the spaceport. The spaceport's Geiger counters continually run, creating a subtle but noticable "white noise".`
spaceport `Large ships continually offload radioactive minerals at the spaceport. The spaceport's Geiger counters continually run, creating a subtle but noticeable "white noise".`

planet "Letty"
landscape "land/letty"
Expand Down
2 changes: 1 addition & 1 deletion data/hails/animeorg hails.txt
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ phrase animeorg.hails.hostile.2
"Hostility"
"Acts of aggression"
"Deliberate aggression"
"Premeditated agression"
"Premeditated aggression"
word
" "
word
Expand Down
2 changes: 1 addition & 1 deletion data/jobs/misc/martieu data smuggling.txt
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ trade

phrase "Martieu Data Smuggling Failure"
word
`While attempting to unload the <commodity>, you are stopped by a large group of armed police entering your ship. They check the data and find the illegal material. You are fined 4 million credits for posession of such a large amount of "objectionable" material. Thankfully, you receive your 2 million payment, so you only lose 2 million.`
`While attempting to unload the <commodity>, you are stopped by a large group of armed police entering your ship. They check the data and find the illegal material. You are fined 4 million credits for possession of such a large amount of "objectionable" material. Thankfully, you receive your 2 million payment, so you only lose 2 million.`

phrase "Martieu Data Smuggling Success"
word
Expand Down
2 changes: 1 addition & 1 deletion data/map.txt
Original file line number Diff line number Diff line change
Expand Up @@ -2158,7 +2158,7 @@ planet Merschre
outfitter "Ammo North"
outfitter "Sayari Outfits"
description "Merschre is another Earth-like planet held by the Sayari Plushie Authority. 40% of the planet is a nature reserve, and the remaining land is mainly for agricultural use, as one of the planets that maintain the SPA's active supply of food. Crops grown here range from wheat, rice, to more obscure crops such as native fruits and vegetables."
spaceport "The Merschre spaceport is relatively large. Many of the traders here sell food. The main spaceport, Merschre Central, is one of the busiest in the Illumina Regions, rivalling that of Laateli. There are several landing pads, some of them are unusually large, to accomodate the SPA's favorite ship, the Amidala. Most of the people here are farmers, as far as you can tell from their clothing. In addition to Merschre Central, there is a large SPA-controlled shipyard selling many types of ships."
spaceport "The Merschre spaceport is relatively large. Many of the traders here sell food. The main spaceport, Merschre Central, is one of the busiest in the Illumina Regions, rivalling that of Laateli. There are several landing pads, some of them are unusually large, to accommodate the SPA's favorite ship, the Amidala. Most of the people here are farmers, as far as you can tell from their clothing. In addition to Merschre Central, there is a large SPA-controlled shipyard selling many types of ships."
government "Sayari Plushie"


Expand Down
2 changes: 1 addition & 1 deletion data/misc/deprecated.txt
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ ship Berserker "Berserker Miner"

mission fi.destroyCSSFpatrol.small.1.spa
name "Destroy small CSSF patrol"
description "A CSSF patrol has been sighted near <system> and must be destroyed. Anyone who destroys them will recieve a payment of <payment>. The Republic will not attack you as they currently turn a blind eye to the conflict between the CSSF and the SPA."
description "A CSSF patrol has been sighted near <system> and must be destroyed. Anyone who destroys them will receive a payment of <payment>. The Republic will not attack you as they currently turn a blind eye to the conflict between the CSSF and the SPA."
job
repeat
to offer
Expand Down
2 changes: 1 addition & 1 deletion data/pelitol cluster.txt
Original file line number Diff line number Diff line change
Expand Up @@ -3782,7 +3782,7 @@ planet Perechra
landscape "land/perechra"
government "Sayari Plushie"
attributes frontier
description "Perechra is an Earth-like world and the easternmost world in the Pelitol Cluster. With a population of 12,000, the world's facilties are primitive and meet only the barebones basic standards of medicine, hygiene and other critical services. Perechra is most often used as a rest stop for ships making their way to either Kaistra or Salistra."
description "Perechra is an Earth-like world and the easternmost world in the Pelitol Cluster. With a population of 12,000, the world's facilities are primitive and meet only the barebones basic standards of medicine, hygiene and other critical services. Perechra is most often used as a rest stop for ships making their way to either Kaistra or Salistra."
spaceport "The spaceport is barebones, with just 5 landing pads for large ships. You see 4 small ships on one of the landing pads. People here give you weird looks, since not many people land often. Dental offices, shopping centers, and even a small hospital are visible from where you currently are."

planet "Salistra"
Expand Down
5 changes: 2 additions & 3 deletions data/sidemissions/animeorg anime retrieval.txt
Original file line number Diff line number Diff line change
Expand Up @@ -43,15 +43,14 @@ mission "animeorg anime retrieval"
goto sure

label sure
` "We recently purchased data drives containing some extremely rare anime from a private collector. Sadly, for the past few days, we have been unable to arrange for a captain to transport the anime, as all our ships were currently unavailable for courier jobs. Until we found you. We would like you to pick up the drives on <stopovers> and bring them back here to <origin>."`
` "The private collector will be waiting for you on Alexandria, in the visitor center. Scan through all the tables until you find them. You will be paid <payment> for this once we confirm that the anime is directly within our posession", explains the worker.`
` "We recently purchased data drives containing some extremely rare anime from a private collector. Sadly, for the past few days, we have been unable to arrange for a captain to transport the anime, as all our ships were currently unavailable for courier jobs. Until we found you. We would like you to pick up the drives on <stopovers> and bring them back here to <origin>.`
` "The private collector will be waiting for you on Alexandria, in the visitor center. Scan through all the tables until you find them. You will be paid <payment> for this once we confirm that the anime is directly within our possession," explains the worker.`
choice
` "Got it."`
accept
` "Sorry, but I'm not going all the way to <stopovers>."`
decline
` "All this, over some silly anime?"`
goto insultAnime

label insultAnime
` The worker, enraged that you have insulted anime, pulls out their gun and terminates you.`
Expand Down
2 changes: 1 addition & 1 deletion data/sidemissions/date format.txt
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ mission "Person ranting about date format"
label ymdRant
` After a slight pause of a few seconds, the person pulls out a loudspeaker and begins speaking through it, broadcasting their opinions about the date format for the whole spaceport to hear.`
` "It's all so confusing! At least spell out the date or use year-month-day! But seriously, year-month-day is so much better because it's just so logical! It goes largest to smallest, it's still logical when you add the time to it, and it's been an international standard for so long!", rants the person.`
` They continue their rant. "It's always clear, and if everybody was using it we wouldn't have to be so confused about wheter a date like 04/07 is April 7th or the 4th of July! I've already sent so many emails to shipyards everywhere requesting they change their date format to year-month-day and they all keep saying no!"`
` They continue their rant. "It's always clear, and if everybody was using it we wouldn't have to be so confused about whether a date like 04/07 is April 7th or the 4th of July! I've already sent so many emails to shipyards everywhere requesting they change their date format to year-month-day and they all keep saying no!"`
` "Year-month-day is the way to keep our society running without the evils of unclear date formats! Down with all other formats!"`
choice
" (Continue listening.)"
Expand Down
2 changes: 1 addition & 1 deletion data/sidemissions/gh codevault.txt
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ mission githubCodeVault.conversation
set "githubCodeVault.didConversation"

on offer
log "Factions" "GitHub" "GitHub was an organization founded in the 21st century. During the early 21st century, they distributed computer code via a development model called 'open source'. GitHub as an organization collapsed during the 23rd century. In addiiton to the distribution of computer code, GitHub also assisted in the development of large projects, often developed by multiple people, by making use of an ancient 'version control system' known as Git."
log "Factions" "GitHub" "GitHub was an organization founded in the 21st century. During the early 21st century, they distributed computer code via a development model called 'open source'. GitHub as an organization collapsed during the 23rd century. In addition to the distribution of computer code, GitHub also assisted in the development of large projects, often developed by multiple people, by making use of an ancient 'version control system' known as Git."

log "Minor People" "Linus Torvalds" "Software engineer born on Earth in the 20th century (c. 1965 - 1970). Known mostly for his effort in developing the 'Linux kernel', development of which continues well in the 31st century. 95% of computers in human space run operating systems that use the Linux kernel."

Expand Down
2 changes: 1 addition & 1 deletion docs/lore/GrowingUp.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,4 @@ LEEST equivalent of https://github.com/endless-sky/endless-sky/wiki/HumanSpace b
Your family is insanely religious, most likely Christian. Before every little activity you pray, sometimes for much longer than the duration of the activity. Depending on how religious your family were, you were taught that God created the universe 7000 years ago. As far as you know, you've never met a same-sex couple. Or an atheist. And every Sunday you went to church, to listen to long and uninspiring sermons. Your parents watched with glee while you only silently listened, not being enthusiastic at all. On some weeks, your knees would hurt from the kneeling the congregation did while praying.

## Sayari Plushie Authority
You probably had a normal childhood. From a young age you always had a squirrel plushie, and everybody else at school had one of their own too. Your parents worked in large textile factories manufacturing Sayari-related merchandise such as the squirrel plushie you always slept with. Regarding religion, you were most likely raised as an atheist, as with many of your children (but sometimes there were Muslims or Christians present). The Sayari Plushie Authority was a name you'd always recognized; in fact it was omnipresent that it may have been the first word you learned to read, long before you uttered the word *mama*.
You probably had a normal childhood. From a young age you always had a squirrel plushie, and everybody else at school had one of their own too. Your parents worked in large textile factories manufacturing Sayari-related merchandise such as the squirrel plushie you always slept with. Regarding religion, you were most likely raised as an atheist, as with many of your children (but sometimes there were Muslims or Christians present). The Sayari Plushie Authority was a name you'd always recognized; in fact it was so omnipresent that it may have been the first word you learned to read, long before you uttered the word *mama*.
5 changes: 3 additions & 2 deletions old_CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,8 @@ faction.purpose.name.size.num
* `size`: size of fleet, solely based on ship count, `lrg, med, sml`; definition of size can be subjective
* `num`: for specifying different variants if more precise control instead of `variant #num` desired

If two variants of a fleet exist, you may have them under 1 fleet as a variant or define them seperately for more precise control.
If two variants of a fleet exist, you may have them under 1 fleet as a variant or define them separately for more precise control.

### Mission names
* `st` Story missions
* `fl` Flavor text (e.g Free Worlds secession dialogue)
Expand Down Expand Up @@ -45,7 +46,7 @@ tr.cargo.size.pirateRisk.num.#Faction

* `pirateRisk`: `lrg, med, sml`, involvement of capital ships is considered `lrg`, medium warships `med`, interceptors and small warships `sml`. `pirateRisk` will be the risk of attack from Merchants, Syndicate, and Republic ships if the mission is offered by pirates (e.g smuggling.)
* `num`: increments up, used for offering missions more than one at a time.
* `#Faction`: if the mission is faction specific. use short names. ideally, you should define faction-specific missions in a seperate file.
* `#Faction`: if the mission is faction specific. use short names. ideally, you should define faction-specific missions in a separate file.
* if the mission falls under two categories, the two shall be separated by hyphens ("-"). the `st` flag will always go first.
> NO: `pi-st.bunks.lrg.med.1`
> YES: `st-pi.bunks.lrg.med.69`

0 comments on commit a24431e

Please sign in to comment.