Skip to content

Commit

Permalink
feat: update readme content
Browse files Browse the repository at this point in the history
Signed-off-by: hxtree <[email protected]>
  • Loading branch information
hxtree committed Oct 14, 2023
1 parent ffaad53 commit 6227c07
Show file tree
Hide file tree
Showing 4 changed files with 22 additions and 11 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,8 +80,8 @@ See [Documentation](docs/index.md).

[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](http://makeapullrequest.com)

Join us in building the future of gaming! Contribute to this repo and help shape
the next generation of immersive entertainment.
Join us in the build! Contribute to help shape the next generation of immersive
entertainment.

Pull requests and bug reports are welcome on GitHub at
<https://github.com/hxtree/cats-cradle>. This project is intended to be a safe,
Expand Down
8 changes: 4 additions & 4 deletions services/dialogue-service/README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# @cats-cradle/dialogue-service

This services manages the dialogue for the game. Dialogue files are stored in
Ink format. This allows for conditional choices between messages and for tags to
be passed to game engine.
Ink format. The Ink format allows for conditional choices between messages and
for tags to be passed to game engine.

Ink tags can be used for actorId, actorExpression/actorSprite, or other meta
data.
Expand All @@ -14,8 +14,8 @@ Dialogue files can be viewed and edited using

## Ideas

The following private repo raw ideas related to the game. Established
contributors should ask for access.
The following private repo contains rough ideas for the game. Established
contributors can request for access.

- [Rough Ideas](https://github.com/hxtree/cats-cradle-ideas)

Expand Down
15 changes: 13 additions & 2 deletions services/dialogue-service/public/en/acts/3_candles/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,20 @@
3. They head to the military capital to go look through the military records to
see what happened to Vallon. They spend much time researching through the
books, which isn't their strong suite. They have been using their real
identities. ???. Faye joins party.
identities.

4. ???
4. Malace and Meeku run into Faye in the library who is a exceptional study.
Faye has read and impressive number of books in the monastery. She is trying
to solve the mystery of villagers that have gone missing.

5. They learn that by blowing out all the candles in the monastery they can
reveal the creature who has been taking the villagers. The creature is only
visible in darkness under green light, it becomes transparent under forms of
red and blue light. It has been slumbering above. They narrowly defeat the
creature and Faye agrees to join their party.

6. The military finds out who they are. The city is filled with wanted posted.
The party departs.

## Notes

Expand Down
6 changes: 3 additions & 3 deletions services/time-keeper/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,9 @@ Time Format:

-00E-053-0125HT

Game time should always be going. There should be no downtime while accessing
menus. When a player select a character and goes into thier equipment menu they
adjust it live with while the majority of the screen is visiable.
Game time is always be going. There should be no downtime while accessing menus.
When a player select a character and goes into their equipment menu they adjust
it live with while the majority of the screen is visible.

A pause feature may be used but would freeze all players menu in a game
instance.

0 comments on commit 6227c07

Please sign in to comment.