diff --git a/cdn/README.md b/cdn/README.md new file mode 100644 index 0000000..1c2b473 --- /dev/null +++ b/cdn/README.md @@ -0,0 +1,6 @@ +# cdn + +Content Delivery "Network" for images and the client's static JSON. + +This doesn't do much on its own, but it does support authenticated image uploads for user and clan avatars. +The authentication uses the `token_secret.key` to prove this server and client (the other server) are part of the same rc-servers instance. diff --git a/polariton_auth/README.md b/polariton_auth/README.md new file mode 100644 index 0000000..fc4a997 --- /dev/null +++ b/polariton_auth/README.md @@ -0,0 +1,4 @@ +# polariton_auth + +Authentication library used for all polariton connection handshakes. +This implements the key derivation for the key exchange in all PUN services (usually part of their respective `main.rs` files). diff --git a/rc_auth/README.md b/rc_auth/README.md new file mode 100644 index 0000000..dca1583 --- /dev/null +++ b/rc_auth/README.md @@ -0,0 +1,4 @@ +# rc_auth + +Client authentication HTTP service. +This also implements intercom services for relaying messages between other services. diff --git a/rc_chat/README.md b/rc_chat/README.md new file mode 100644 index 0000000..1ab5efc --- /dev/null +++ b/rc_chat/README.md @@ -0,0 +1,4 @@ +# rc_chat + +Chat PUN service bouncer. +This immediately sends all new connections to the configured `rc_chat_room` service. diff --git a/rc_chat_room/README.md b/rc_chat_room/README.md new file mode 100644 index 0000000..3a95bba --- /dev/null +++ b/rc_chat_room/README.md @@ -0,0 +1,4 @@ +# rc_chat_room + +Chat PUN service. +This handles sending messages between users in global channels, clan channels, battle (team and all) channels, and private (1 on 1) channels. diff --git a/rc_core/README.md b/rc_core/README.md new file mode 100644 index 0000000..e42d858 --- /dev/null +++ b/rc_core/README.md @@ -0,0 +1,3 @@ +# rc_core + +Common functionality shared between all services. diff --git a/rc_database/README.md b/rc_database/README.md new file mode 100644 index 0000000..25b0c1e --- /dev/null +++ b/rc_database/README.md @@ -0,0 +1,3 @@ +# rc_database + +Database functionality shared between all services. diff --git a/rc_factory/README.md b/rc_factory/README.md new file mode 100644 index 0000000..d553c8c --- /dev/null +++ b/rc_factory/README.md @@ -0,0 +1,3 @@ +# rc_factory + +Common Community Robot Factory (CRF) functionality shared between all services. diff --git a/rc_factory_web/README.md b/rc_factory_web/README.md new file mode 100644 index 0000000..ee0658d --- /dev/null +++ b/rc_factory_web/README.md @@ -0,0 +1,3 @@ +# rc_factory_web + +Factory website service inspired by `factory.robocraftgame.com` (which is no longer online). diff --git a/rc_lobby/README.md b/rc_lobby/README.md new file mode 100644 index 0000000..7f078b2 --- /dev/null +++ b/rc_lobby/README.md @@ -0,0 +1,4 @@ +# rc_lobby + +Lobby PUN service bouncer. +This immediately sends all new connections to the configured `rc_lobby_room` service. diff --git a/rc_lobby_room/README.md b/rc_lobby_room/README.md new file mode 100644 index 0000000..54fcf98 --- /dev/null +++ b/rc_lobby_room/README.md @@ -0,0 +1,4 @@ +# rc_lobby_room + +Lobby PUN service. +This handles matchmaking and directing clients to the configured `rc_multiplayer` service to start a match. diff --git a/rc_microtransactions/README.md b/rc_microtransactions/README.md new file mode 100644 index 0000000..f315ebf --- /dev/null +++ b/rc_microtransactions/README.md @@ -0,0 +1,5 @@ +# rc_microtransactions + +Client payment HTTP service. +This is supposed to handle real money transactions, from what can be bought to directing the client to a payment processor. +Only the bare minimum is actually implemented. diff --git a/rc_multiplayer/README.md b/rc_multiplayer/README.md new file mode 100644 index 0000000..4040a54 --- /dev/null +++ b/rc_multiplayer/README.md @@ -0,0 +1,6 @@ +# rc_multiplayer + +Multiplayer LiteNetLib service. +This handles all match functionality for all gamemodes from loading into the match to sending the clients back to the main menu (garages). + +This makes use of the `LiteRustLib` and `rlnl` crates which are not included in this repository but are part of the larger OpenJam project. diff --git a/rc_plugins/README.md b/rc_plugins/README.md new file mode 100644 index 0000000..2be6bbc --- /dev/null +++ b/rc_plugins/README.md @@ -0,0 +1,4 @@ +# rc_plugins + +Common plugin APIs used across many services. +These define external interfaces for interacting with external code to expand service functionality in certain ways. diff --git a/rc_services/README.md b/rc_services/README.md new file mode 100644 index 0000000..e0d911f --- /dev/null +++ b/rc_services/README.md @@ -0,0 +1,4 @@ +# rc_services + +Web service PUN service bouncer. +This immediately sends all new connections to the configured `rc_services_room` service. diff --git a/rc_services_room/README.md b/rc_services_room/README.md new file mode 100644 index 0000000..9ad96e3 --- /dev/null +++ b/rc_services_room/README.md @@ -0,0 +1,4 @@ +# rc_services_room + +Web services PUN service. +This handles the primary functionality for the client, from sending config data to the client during login to garage bay operations. diff --git a/rc_singleplayer/README.md b/rc_singleplayer/README.md new file mode 100644 index 0000000..d8295dd --- /dev/null +++ b/rc_singleplayer/README.md @@ -0,0 +1,4 @@ +# rc_singleplayer + +Singleplayer PUN service bouncer. +This immediately sends all new connections to the configured `rc_singleplayer_room` service. diff --git a/rc_singleplayer_room/README.md b/rc_singleplayer_room/README.md new file mode 100644 index 0000000..2858245 --- /dev/null +++ b/rc_singleplayer_room/README.md @@ -0,0 +1,5 @@ +# rc_singleplayer_room + +Singleplayer PUN service. +This handles singleplayer functionality, though there is not much functionality there since it was designed to be mostly functional without an internet connection. +This sends NPC vehicles for the client to spawn into the match as well as saving the end of match results (scores). diff --git a/rc_social/README.md b/rc_social/README.md new file mode 100644 index 0000000..6489d9f --- /dev/null +++ b/rc_social/README.md @@ -0,0 +1,4 @@ +# rc_social + +Social PUN service bouncer. +This immediately sends all new connections to the configured `rc_social_room` service. diff --git a/rc_social_room/README.md b/rc_social_room/README.md new file mode 100644 index 0000000..30426e5 --- /dev/null +++ b/rc_social_room/README.md @@ -0,0 +1,4 @@ +# rc_social_room + +Social PUN service. +This handles clan, friend, party, and custom game functionality.