From eb4ee71ed4100d1aa09127ea71dc37344fb76c94 Mon Sep 17 00:00:00 2001 From: Bottersnike Date: Fri, 4 Feb 2022 01:22:50 +0000 Subject: [PATCH] Update readmes --- README.md | 52 +++++++++++++++++++++++++++------------------------- eaapi | 2 +- 2 files changed, 28 insertions(+), 26 deletions(-) diff --git a/README.md b/README.md index de139ab..0ccf5e4 100644 --- a/README.md +++ b/README.md @@ -1,40 +1,42 @@ -# EAAPI +# e-Amusement Universe Repo -These scripts should be considered complementary to the documentation, not the -other way round. Experimental or unconfirmed this may be present here, however -the doc pages should for the most part only contain confirmed information. +This is a meta repository for different components of my e-Amusement +implementation. This has been done to facilitate partial-access to certain +parts of the codebase using gitea permissions. -If you came here looking for a complete e-Amusement implementation, you -probably want https://github.com/DragonMinded/bemaniutils instead. +Do **not** clone this repository recursively. It will probably fail. Instead, +`setup` should be run after cloning, which will initialise any submodules you +have access to, and will also setup the `eaapi` package (assuming it cloned). -# Requirements -Rather than rolling my own ARC4 and Triple-DES implementations (why does everyone seem to do that?) -I instead opted to just use `pycryptodome`. `lxml` is required for the parsing of string packets, -but is not a hard dependency. +This script assumes both `git` and `py` are on the path. -# Keys -In order to run this code, some encryption keys need loaded in. I have opted to not include them in -this repo because I didn't really feel like doing that. May or may not change that stance later. +I'm happy to provide individual access to the majority of these child +repositories on request. -For now, copy `eaapi/keys.template.py` to `eaapi/keys.py`, and fill in the blanks. If you're -following along with docs, you already have the values you need. Otherwise, I trust you can figure -out somewhere to find them. `CARDCONV_KEY` is only required if you plan to make use of `cardconv`. +The `.cmd` helper scripts in this repo are mostly for bulk management of the +submodules; here be dragons! -## `eaapi/` -The actual implementation of stuff. +## `docs` +The source and build system for https://bsnk.me/eamuse/ -## `tests/` -An incredibly incomplete test suite. Run with `test` if you're on windows and lazy. +## `eaapi` +The main implementation of the e-Amusement transport layers. -## `server-dummy/` +Make sure to read the README here because otherwise nothing will start. + +## `eaapi/eaapi/server` +A surprisingly capable werkzeug server for rapid development of e-Amusement +servers. + +## `server-dummy` A super barebones e-Amusement server that's able to start a surprising number of games. Largely exists as a proof of concept, and as a testing ground for specific endpoints without having the overhead of an entire EA server running. -## `server/` +## `server-full` A less barebones server, used for experiementing with more complex behaviours. This probably won't -get pushed until it's had a significant tidy. +ever end up public, but now you know what it is I guess. -## `proxy/` +## `proxy` An e-Amusement server designed to proxy requests to a different upstream server, while allowing the -observation of requests as they're made. As above, probably won't push this for a bit. +observation of requests as they're made. diff --git a/eaapi b/eaapi index af5dfb3..40a6ffb 160000 --- a/eaapi +++ b/eaapi @@ -1 +1 @@ -Subproject commit af5dfb3f6c908a6e1efbdfa99adc80a24217cf96 +Subproject commit 40a6ffbb0d0e01f4635b79a81a1d33ce7e752d54