eamuse
/
universe
2
1
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Update readmes

This commit is contained in:
Bottersnike 2022-02-04 01:22:50 +00:00
parent 0597d90481
commit eb4ee71ed4
2 changed files with 28 additions and 26 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

52
README.md
View File

@ -1,40 +1,42 @@
# EAAPI # e-Amusement Universe Repo
These scripts should be considered complementary to the documentation, not the This is a meta repository for different components of my e-Amusement
other way round. Experimental or unconfirmed this may be present here, however implementation. This has been done to facilitate partial-access to certain
the doc pages should for the most part only contain confirmed information. parts of the codebase using gitea permissions.
If you came here looking for a complete e-Amusement implementation, you Do **not** clone this repository recursively. It will probably fail. Instead,
probably want https://github.com/DragonMinded/bemaniutils 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 This script assumes both `git` and `py` are on the path.
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.
# Keys I'm happy to provide individual access to the majority of these child
In order to run this code, some encryption keys need loaded in. I have opted to not include them in repositories on request.
this repo because I didn't really feel like doing that. May or may not change that stance later.
For now, copy `eaapi/keys.template.py` to `eaapi/keys.py`, and fill in the blanks. If you're The `.cmd` helper scripts in this repo are mostly for bulk management of the
following along with docs, you already have the values you need. Otherwise, I trust you can figure submodules; here be dragons!
out somewhere to find them. `CARDCONV_KEY` is only required if you plan to make use of `cardconv`.
## `eaapi/` ## `docs`
The actual implementation of stuff. The source and build system for https://bsnk.me/eamuse/
## `tests/` ## `eaapi`
An incredibly incomplete test suite. Run with `test` if you're on windows and lazy. 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. 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 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. 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 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 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.

2
eaapi

@ -1 +1 @@
Subproject commit af5dfb3f6c908a6e1efbdfa99adc80a24217cf96 Subproject commit 40a6ffbb0d0e01f4635b79a81a1d33ce7e752d54