fixed some markdown formatting
This commit is contained in:
@@ -1,16 +1,20 @@
|
||||
# HAPPENING
|
||||
An interactive story telling software.<br/>
|
||||
# Happening
|
||||
|
||||
An interactive story telling software.
|
||||
Read and write people's stories
|
||||
|
||||
## Install
|
||||
|
||||
This is not really out of development, but to run it, clone the repo, go into /server/ and use cargo run story.zip to run a file called story.zip that's in the /stories/ directory.
|
||||
|
||||
## Technical Details
|
||||
## Technical Details
|
||||
|
||||
### Back-end server -- Rust
|
||||
|
||||
The server component of Happening will be written in Rust.<br/>
|
||||
Parses the code and sends it via the API.<br/>
|
||||
File layout:<br/>
|
||||
File layout:
|
||||
|
||||
- animations/
|
||||
- features/
|
||||
- scenes/
|
||||
@@ -33,6 +37,7 @@ The variables are stored as a hashmap, characters are objects.<br/>
|
||||
Using the network interface, port 20264.<br/>
|
||||
|
||||
Characters are sent to the frontend and stored there when the character is created on the frontend.<br/>
|
||||
|
||||
```
|
||||
{
|
||||
|
||||
@@ -44,9 +49,10 @@ character: String,
|
||||
|
||||
}
|
||||
```
|
||||
|
||||
### Frontend -- Python
|
||||
|
||||
Things the frontend can do:<br/>
|
||||
Things the frontend can do:
|
||||
|
||||
- Output text
|
||||
- Display the character
|
||||
@@ -58,6 +64,7 @@ Things the frontend can do:<br/>
|
||||
#### Setup
|
||||
|
||||
This is done in the about.json file,
|
||||
|
||||
```
|
||||
{
|
||||
|
||||
@@ -67,39 +74,25 @@ This is done in the about.json file,
|
||||
|
||||
}
|
||||
```
|
||||
|
||||
#### Characters
|
||||
See [Character documentation](/docs/CHARACTER.md] for more info
|
||||
|
||||
See [Character documentation](/docs/CHARACTER.md) for more info
|
||||
Referencing a character using the @, @NARRATOR is reserved for the Narrator.<br/>
|
||||
Customisation is done with @CHARACTER change \<feature\> into \<feature name\><br/>
|
||||
Move a character with @CHARACTER to fr
|
||||
|
||||
attributes:<br/>
|
||||
|
||||
- gender
|
||||
- skin_color
|
||||
- name
|
||||
- eye_color
|
||||
- pronoun_subject
|
||||
- pronoun_object
|
||||
- pronoun_deppos
|
||||
- pronoun_indpos
|
||||
- pronoun_reflex
|
||||
- animation
|
||||
- head
|
||||
- hair
|
||||
- torso
|
||||
- arm
|
||||
- leg
|
||||
- hair_color
|
||||
- top_clothing
|
||||
- bottom_clothing
|
||||
- shoes
|
||||
> [!NOTE]
|
||||
> fr means front-right for instance.
|
||||
|
||||
#### Outputs
|
||||
|
||||
```
|
||||
@CHARACTER says "this string
|
||||
is multi-line
|
||||
and ends with a"
|
||||
```
|
||||
|
||||
#### Variables
|
||||
|
||||
Variables are referenced with the \$, only integers will be supported.<br/>
|
||||
@@ -107,6 +100,7 @@ Variables are referenced with the \$, only integers will be supported.<br/>
|
||||
#### Selection
|
||||
|
||||
Condition based:
|
||||
|
||||
```
|
||||
if (condition) {
|
||||
|
||||
@@ -120,7 +114,9 @@ else
|
||||
|
||||
}
|
||||
```
|
||||
|
||||
Choice based:
|
||||
|
||||
```
|
||||
choice "choice 1" {
|
||||
|
||||
@@ -134,45 +130,59 @@ or "choice 3" {
|
||||
|
||||
}
|
||||
```
|
||||
|
||||
#### Positioning
|
||||
|
||||
```
|
||||
@CHARACTER to position
|
||||
|
||||
PAN to position
|
||||
```
|
||||
|
||||
#### Other
|
||||
|
||||
```
|
||||
label:
|
||||
|
||||
GOTO label
|
||||
```
|
||||
|
||||
#### Ending
|
||||
|
||||
`END` to exit out of the story
|
||||
|
||||
## Implemented stuff
|
||||
|
||||
### Commands
|
||||
|
||||
| Command | Implemented |
|
||||
|-----------------|-------------|
|
||||
| --------------- | ----------- |
|
||||
| END | Yes |
|
||||
| CHOICE/OR/OR | Yes |
|
||||
| IF/ELSE IF/ELSE | No |
|
||||
| GOTO | No |
|
||||
| PAN | No |
|
||||
|
||||
### Character sub-commands
|
||||
|
||||
| Character Command | Implemented |
|
||||
|-------------------|-------------|
|
||||
| ----------------- | ----------- |
|
||||
| SAYS | Yes |
|
||||
| CHANGE | Yes |
|
||||
| TO | Yes |
|
||||
| ANIMATE | Yes |
|
||||
|
||||
### Other Features
|
||||
| Feature | Implemented |
|
||||
| --------- | ----------- |
|
||||
| Variables | No |
|
||||
|
||||
| Feature | Implemented |
|
||||
| ---------- | ----------- |
|
||||
| Variables | No |
|
||||
| about.json | No |
|
||||
|
||||
## Error codes
|
||||
|
||||
| | | |
|
||||
|---------|---------------------------------------------|-----------------------------------------------------------------------------------------|
|
||||
| ------- | ------------------------------------------- | --------------------------------------------------------------------------------------- |
|
||||
| Code ID | Meaning | Possible remedies |
|
||||
| 0 | Success | N/A |
|
||||
| 1 | File unexpectedly reached termination point | Make sure there is an END statement in the code. |
|
||||
@@ -189,5 +199,4 @@ GOTO label
|
||||
| 12 | Failed to open archive | Make sure the story file is a zip archive. |
|
||||
| 13 | Unable to setup the characters hashmap. | Make sure the characters.json file exists, is valid JSON and contains valid characters. |
|
||||
| 14 | Unable to read the main story file. | Make sure the story.ha file exists and is readable. |
|
||||
| 15 | | |
|
||||
|
||||
| 15 | | |
|
||||
Reference in New Issue
Block a user