This commit is contained in:
Julia Cavanaugh 2023-11-29 21:27:08 -06:00
commit ffc7e9265e
2 changed files with 44 additions and 4 deletions

21
LICENSE Normal file
View File

@ -0,0 +1,21 @@
MIT License
Copyright (c) 2023 Lauthai
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

View File

@ -6,9 +6,10 @@ This server is made using Java, Spring Boot and Maven in Java 8.
*If someone wants to update the Java version, be my guest*
```
Lauthai started this server while working in tandem with Lako, who was developing in their own code. Both servers have many of the same features available, but there are a few that haven't been ported over to this server (Lucky, Sprocket, Snipe and Dyer's games), and will need to be ported at some point by someone.
```
> Lauthai started this server while working in tandem with Lako, who was developing in their own code. Both servers have many of the same features available, but there are a few that haven't been ported over to this server (Lucky, Sprocket, Snipe and Dyer's games), and will need to be ported at some point by someone.
>
> Lako's Repo is here: [A1Emu](https://github.com/GittyMac/A1Emu)
## Project Features
The following lists will help keep track of what features are implemented, partial working, and not yet implemented.
@ -64,12 +65,14 @@ The following items are currently partially implemented:
#### Galaxy Server
* Challenging Friends to Ace/Mulch Levels
* Currently sends a game response back but causes the game to only display a black screen. Needs investigation into why get_level_info doesn't work properly.
* Sending/Saving Images for shared levels
### Not Yet Implemented
The following items are not yet implemented:
***TRYING TO ACCESS/USE ANY OF THESE FEATURES HAVE A MUCH HIGHER LIKELYHOOD OF CRASHING YOUR GAME - DO NOT ATTEMPT TO ACCESS WHILE USING THE SERVER***
#### ArkOne Server
* Plugin 2 - Chat Rooms
* Plugin 4 - Jongg Challenge
* Plugin 6 - Bombastic Billiards
@ -78,6 +81,9 @@ The following items are not yet implemented:
* Plugin 11 - Rasteroids
* Plugin 12 - Lilytadd Tiles
#### Galaxy Server
* Ace Mulch Trophy Icon
Features from Lako's Server that need to be migrated:
* Sprocket's Game
* Snipe's Game
@ -124,12 +130,25 @@ The .war file can be deployed using something like Tomcat to host the webapp. T
* 80 - HTTP
* 20502 - TCP
### Configuring OpenFK
Lastly, you will need to run the "Configure OpenFK.bat" located in your installation directory. First check the box to enable networking. Then you'll need to set the following fields replcating "127.0.0.1" with the server's IP address (can leave as is if just running locally):
```
HTTP Host 1: http://127.0.0.1:80
HTTP Host 2: http://127.0.0.1:80
TCP Host: 127.0.0.1
TCP Port: 20502
```
## Contributing
We welcome people to open pull requests as you complete and implement any of the missing/partially working features! The more that people help out, the faster we can restore every feature that once existed!
## BUGS?!
If you find a bug, please report it here on GitHub so that we can track it to ensure it is properly taken care of.
## Credits
As people contribute to the development of the server they will be added here:
* Lauthai
* Lako
* Lako