mirror of https://github.com/BigJk/end_of_eden.git synced 2026-02-06 10:48:09 +00:00

History

Daniel Schmidt 89e422ff52 Hub prototyping.		2023-05-27 09:16:41 +02:00
..
docs	Added new lines to lua docs.	2023-04-30 11:57:57 +02:00
fuzzy-tester	Added dynamic event choices description.	2023-05-03 22:31:11 +02:00
game	Make settings decoupled for ui.	2023-05-19 00:56:45 +02:00
game_browser	Renamed project to 'End of Eden'	2023-04-23 22:04:24 +02:00
game_hub	Hub prototyping.	2023-05-27 09:16:41 +02:00
game_ssh	Disable clipboard in SSH.	2023-05-19 01:02:37 +02:00
game_win	Fix grain and remove dpi setting.	2023-05-23 22:42:24 +02:00
README.md	Added help console prints.	2023-05-01 11:43:58 +02:00

README.md

Executables

Game

End Of Eden :: Game

  -artifacts string
        test artifacts
  -audio
        disable audio (default true)
  -cards string
        test cards
  -enemies string
        test enemies
  -game_state string
        test game state
  -help
        show help

Game Browser

The base game but running in browser
ttyd is needed as dependency, either in your path or in the sub-folder of the working directory

ttyd search paths

ttyd
./ttyd/ttyd.win32.exe
./ttyd/ttyd.aarch64
./ttyd/ttyd.arm
./ttyd/ttyd.armhf
./ttyd/ttyd.i686
./ttyd/ttyd.mips
./ttyd/ttyd.mips64
./ttyd/ttyd.mips64el
./ttyd/ttyd.mipsel
./ttyd/ttyd.s390x
./ttyd/ttyd.x86_64

Game SSH

End Of Eden :: SSH Server
Each SSH session creates it's own game session. Modding and audio not supported.

  -bind string
        ip and port to bind to (default ":8273")
  -help
        show help
  -max_inst int
        maximum of game instances (default 10)
  -timeout int
        ssh idle timeout

Docs

Generates the LUA documentation of the game and prints a markdown formatted text to stdout.
go run ./cmd/docs > LUA_API_DOCS.md

Fuzzy Tester

End Of Eden :: Fuzzy Tester
The fuzzy tester hits a game session with a random number of operations and tries to trigger a panic.

  -help
        show help
  -mods string
        mods to load and test, separated by ',' (e.g. mod1,mod2,mod3)
  -n int
        number of goroutines (default 1)
  -seed int
        random seed
  -timeout duration
        length of testing (default 1m0s)

Environment Variables

EOE_NO_PROTECT=1: Disables lua safety and kills the program if a lua error is encountered. Good for debugging.
EOE_DEBUG=1: Enables the debugging api access if a game is started. This needs ttyd and wscat installed for full usage.