archon

README

Archon

Private server implementation for Sega's Phantasy Star Online Blue Burst. Credit is owed to the authors of Tethealla, Newserv, and Sylverant, whose servers I'm studying as I write Archon.

The goal of this project is to build a configurable, high-performing, and scalable PSOBB server that can be run across multiple platforms with little setup overhead. The project is currently in its early stages and changing rapidly while I piece together the PSO protocol and develop a core archiecture.

Forks, bug fixes, issue reports, etc. are welcome!

Installation

Detailed instructions can be found on the wiki.

The project is built using the standard Go language toolchain, which you must install in order to compile and run the project. For installation instructions, visit the Golang website.

With Go installed and your GOPATH set, you can fetch the project:

go get github.com/dcrodman/archon

Server setups with one ship can just compile and run a single binary:

go install github.com/dcrodman/archon
$GOPATH/bin/archon

Documentation

Overview

Constants and structs associated with character data.

* Archon PSO Server * Copyright (C) 2014 Andrew Rodman * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation, either version 3 of the License, or * (at your option) any later version. * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License * along with this program. If not, see <http://www.gnu.org/licenses/>. * --------------------------------------------------------------------- * Client definition for generic handling of connections.

* Archon PSO Server * Copyright (C) 2014 Andrew Rodman * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation, either version 3 of the License, or * (at your option) any later version. * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License * along with this program. If not, see <http://www.gnu.org/licenses/>. * --------------------------------------------------------------------- * * Singleton package for handling the global server configuration * and responsible for establishing a connection to the database * to be maintained during execution.

Login and Character server logic.

* Archon PSO Server * Copyright (C) 2014 Andrew Rodman * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation, either version 3 of the License, or * (at your option) any later version. * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License * along with this program. If not, see <http://www.gnu.org/licenses/>. * ---------------------------------------------------------------------

* Archon PSO Server * Copyright (C) 2014 Andrew Rodman * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation, either version 3 of the License, or * (at your option) any later version. * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License * along with this program. If not, see <http://www.gnu.org/licenses/>. * --------------------------------------------------------------------- * The PATCH and DATA server logic. Both are included here since they're * neither are particularly complicated.

* Archon PSO Server * Copyright (C) 2014 Andrew Rodman * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation, either version 3 of the License, or * (at your option) any later version. * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License * along with this program. If not, see <http://www.gnu.org/licenses/>. * --------------------------------------------------------------------- * * Packet constants and structures. All functions return 0 on success, * negative int on db error, and a positive int for any other errors.

* Archon PSO Server * Copyright (C) 2014 Andrew Rodman * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation, either version 3 of the License, or * (at your option) any later version. * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License * along with this program. If not, see <http://www.gnu.org/licenses/>. * --------------------------------------------------------------------- * Packet types, defintitions, and sending functions.

* Archon PSO Server * Copyright (C) 2014 Andrew Rodman * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation, either version 3 of the License, or * (at your option) any later version. * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License * along with this program. If not, see <http://www.gnu.org/licenses/>. * --------------------------------------------------------------------- * The BLOCK and SHIP server logic.

* Archon PSO Server * Copyright (C) 2014 Andrew Rodman * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation, either version 3 of the License, or * (at your option) any later version. * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License * along with this program. If not, see <http://www.gnu.org/licenses/>. * --------------------------------------------------------------------- * * Handles the connection initialization and management for connected * ships. This module handles all of its own connection logic since the * shipgate protocol differs from the way game clients are processed.