https://github.com/mtkennerly/gfmake
Convert game scripts to GameFAQs Markup.
https://github.com/mtkennerly/gfmake
Last synced: over 1 year ago
JSON representation
Convert game scripts to GameFAQs Markup.
- Host: GitHub
- URL: https://github.com/mtkennerly/gfmake
- Owner: mtkennerly
- License: mit
- Created: 2017-11-23T16:15:01.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2019-05-14T11:46:56.000Z (about 7 years ago)
- Last Synced: 2025-03-21T00:20:12.197Z (over 1 year ago)
- Language: Haskell
- Size: 43.9 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# gfmake
gfmake is a tool written in Haskell to convert the game scripts that I
transcribed from their original format into GameFAQS Markup.
## Usage
From the console:
```
stack build
stack exec -- gfmake --help
stack exec -- gfmake sample1.gfm.txt
stack install
gfmake --help
```
From code:
```haskell
module Main where
import GFMake (convertScript)
main :: IO ()
main = readFile "sample1.gfm.txt" >>= (return . convertScript) >>= putStrLn
```
## Versioning
This project uses Semantic Versioning, *not* PVP. The public API comprises the
command line interface and all exports from non-`Internal` modules under src.
Exporting new names is not considered a breaking change, so use unqualified
imports at your discretion.
## Sample
This is the output for sample1.gfm.txt:
```
;format:gf-markup
; This is a freeform comment without any special characters.
==Header 2==
===Header 3===
===Header 3: Multiple Lines===
===++Header 3b++===
====Header 4====
=====Header 5=====
This is original narration for events. If it is long enough, then it is indented after the hyphen. There may also be multiple paragraphs of narration.
| Speaker | This is text or speech directly from the game. The speaker ID is always padded with spaces to at least 10 characters. This may also have multiple lines. |
| Long Name Here | If the speaker ID is longer than 10 characters, then the indentation is simply shifted over. |
| Narrated | * - Narration can occur inside of a speaker block. Speech occurs at normal indentation. * - Narration is indented an extra 2 spaces. |
====Header 4 Annotated | (an annotation will be present) / (in some rare cases) / (middle line is default, but all three are possible)====
|-3 Condition | A | This is said under condition A. |
| B | This is said under condition B. * - It may include narration as well. |
| *C | Idiosyncratic marker. |
|-f Long | 1 | GameFAQs |
| 2 | Markup |
| 3 | only |
| 4 | supports |
| 5 | rowspan |
| 6 | up |
| 7 | to |
| 8 | 15 |
| 9 | so |
| 10 | anything |
| 11 | more |
| 12 | must |
| 13 | be |
| 14 | in |
| 15 | separate |
|-1 [cont] | 16 | tables. |
=--Option 1--=
| Speaker | This is the response to choosing one option. |
=--Option 1.1--=
| Speaker | This option is available if you choose Option 1. |
=--Six--=
| Speaker | The hyphens continue increasing... |
=--Seven--=
| Speaker | ...until they wrap around to an equal sign. |
=--Twelve--=
| Speaker | The maximum depth is 12 nested options. |
=-=
=-=
=-=
=-=
=-=
=--Option 2--=
| Speaker | This is the alternative to Option 1. |
=-=
```
## To-do
* The plus-formatting for h3b headers doesn't have any significance in GameFAQs
Markup and is just to highlight them for manual cleanup, since there aren't
enough header levels for them to work very well. It would be better to
perform that cleanup automatically.
* Narration and options nested inside of a speech block should be formatted
specially, whereas now they end up all on one line in a jumble.
For nesting inside non-conditional speech, elements could simply be
interspersed around the speech:
```
# Current:
| Narrated | * - Narration can occur inside of a speaker block. Speech occurs at normal indentation. * - Narration is indented an extra 2 spaces. |
# Future:
Narration can occur inside of a speaker block.
| Narrated | Speech occurs at normal indentation. |
Narration is indented an extra 2 spaces.
```
For conditional speech, there would need to be some way to still associate
the nested element with its corresponding condition. Since GameFAQs Markup
does not support multiple lines within a cell, this may require representing
the narration within the same cell as speech:
```
# Current:
|-3 Condition | A | This is said under condition A. |
| B | This is said under condition B. * - It may include narration as well. |
| *C | Idiosyncratic marker. |
# Future?
|-3 Condition | A | This is said under condition A. |
| B | This is said under condition B. {'''It may include narration as well.'''} |
| *C | Idiosyncratic marker. |
```