Leahnaya/A1Emu
1
0
Fork 0
mirror of https://github.com/GittyMac/A1Emu.git synced 2026-03-21 17:44:51 -05:00
Code Issues Actions Packages Projects Releases Wiki Activity

Updated readme for easier readability.

Browse Source
This commit is contained in:
Lako 2023-11-24 01:22:04 -05:00
parent 20fa9f248c
commit d3ccfd8389
2 changed files with 378 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

308
A1DB.sql Executable file
View File

File diff suppressed because one or more lines are too long

74
README.md
View File

@ -1,16 +1,82 @@
> [!IMPORTANT]
> Most contributions to U.B. Funkeys server development should be directed to Lautha1's [UBFunkeysServer repository](https://github.com/Lautha1/UBFunkeysServer) instead of A1Emu.
> [!CAUTION]
> This is an incomplete project! Please do not expect a complete or secure server experience with this.
# A1Emu
An open source recreation of the ArkONE servers used for the 2007 game, U.B. Funkeys.
An open source recreation of the ArkONE servers used for the 2007 game, U.B. Funkeys.
## Installation
## Plugins
ArkONE is designed with multiple plugins for certain aspects/games. Here is a list of the status of A1Emu's plugin reimplementations.
### Fully Implemented
* **Plugin 0** - Core
* **Plugin 1** - Users
* **Plugin 3** - Boxing
* **Plugin 5** - Soccer
* **Plugin 7** - Galaxy
* **Plugin 10** - Trunk
### Partially Implemented
* **Plugin 2** - Chats
* **Plugin 4** - Mahjong
* **Plugin 6** - Pool
## Building
### Dependencies
A1Emu requires .NET 6 and MariaDB to run properly.
To get these dependencies on Ubuntu/Debian:
```apt install dotnet-sdk-6.0 dotnet-runtime-6.0 mariadb-server```
```bash
apt install dotnet-sdk-6.0 dotnet-runtime-6.0 mariadb-server
```
To get these dependencies on RHEL/CentOS/Fedora:
```dnf install dotnet-sdk-6.0 dotnet-runtime-6.0 mariadb-server```
```bash
dnf install dotnet-sdk-6.0 dotnet-runtime-6.0 mariadb-server
```
### Get Source
Fetch the A1Emu repository via Git, and then change into the cloned directory.
```bash
git clone https://github.com/GittyMac/A1Emu
cd A1Emu
```
### Initiating Build
Use the .NET SDK to restore the NuGet packages used by A1Emu and to initiate the build.
```bash
dotnet restore
dotnet build
```
The output will be located in `A1Emu/A1Emu/bin/Debug/net6.0`.
## Running
A1Emu does not generate a SQL database, so you will have to manually create one with MariaDB. A [template SQL file](https://github.com/GittyMac/A1Emu/blob/master/A1DB.sql) is provided to create the basic structure.
```bash
mysql -u [USERNAME] -p [CREATED_DATABASE] < A1DB.sql
```
In the folder containing the A1Emu DLL, there should be a file called `config` created with these contents:
```
port=2000
directory=[DIRECTORY FOR PROFILES]
sq=server=localhost;userid=[USERNAME];password=[PASSWORD];database=FKData
ip=127.0.0.1
```
All you need to do after this is to start the MariaDB server and run A1Emu.dll with .NET.
```bash
dotnet A1Emu.dll
```