gopenfusion/README.md

# gopenfusion

<p align="center">
    <a href="https://github.com/CPunch/gopenfusion/actions/workflows/tests.yaml"><img src="https://github.com/CPunch/gopenfusion/actions/workflows/tests.yaml/badge.svg?branch=main" alt="Workflow"></a>
    <a href="https://github.com/CPunch/gopenfusion/blob/main/LICENSE.md"><img src="https://img.shields.io/github/license/CPunch/gopenfusion" alt="License"></a>
    <br>
    <a href="https://asciinema.org/a/625524" target="_blank"><img src="https://asciinema.org/a/625524.svg" /></a>
</p>

A toy implementation of the [Fusionfall Packet Protocol](https://openpunk.com/pages/fusionfall-openfusion/) (see: `cnet/`) and accompanying services, written in Go.

## Landwalker demo

An implementation of a landwalker server is located in `login/` && `shard/`. This includes a functional login server and a dummy shard (supporting the minimum amount of packets necessary). There is minimal support for NPCs, and minimal support for player interaction (chat & player movement being mostly it).

Startup the environment using

```sh
$ chmod +x ./build.sh && ./build.sh
$ docker compose up
```

The environment consists of a shard service, login service, redis && postgres containers. redis is used to pass login metadata between the login and shard services, while postgres is just used to store player accounts and characters.

login server is hosted at `127.0.0.1:23000`, just join from your [favorite client](https://github.com/OpenFusionProject/OpenFusion/releases/latest)

## Generating structures

Dump and decompile the `Assembly - CSharp.dll` assembly from the fusionfall main.unity3d, using a tool like [ilspycmd](https://www.nuget.org/packages/ilspycmd/). The full output source can then be passed to `genstructs.py` script located in `tools/`, which will handle scraping constants and calculating structure padding. See the script for details on usage.
misc. refactoring 2023-03-07 00:39:41 +00:00			`# gopenfusion`
more better README haven't decided if showing an asciinema of the docker compose environment is really useful or informative. maybe i'll record a GIF of some gameplay in the future 2023-12-06 23:20:58 +00:00
			`<p align="center">`
			`<a href="https://github.com/CPunch/gopenfusion/actions/workflows/tests.yaml"><img src="https://github.com/CPunch/gopenfusion/actions/workflows/tests.yaml/badge.svg?branch=main" alt="Workflow"></a>`
			`<a href="https://github.com/CPunch/gopenfusion/blob/main/LICENSE.md"><img src="https://img.shields.io/github/license/CPunch/gopenfusion" alt="License"></a>`
			`<br>`
			`<a href="https://asciinema.org/a/625524" target="_blank"><img src="https://asciinema.org/a/625524.svg" /></a>`
			`</p>`
misc. refactoring 2023-03-07 00:39:41 +00:00
updated README 2023-12-02 23:04:06 +00:00			A toy implementation of the [Fusionfall Packet Protocol](https://openpunk.com/pages/fusionfall-openfusion/) (see: `cnet/`) and accompanying services, written in Go.
updated README.md 2023-03-07 18:39:12 +00:00
server/shard: added UpdatePlayer(), which should be used whenever player struct state needs to be updated to prevent race conditions 2023-03-27 02:08:13 +00:00			`## Landwalker demo`
updated README 2023-03-10 06:58:29 +00:00
updated readme 2023-08-23 23:05:03 +00:00			An implementation of a landwalker server is located in `login/` && `shard/`. This includes a functional login server and a dummy shard (supporting the minimum amount of packets necessary). There is minimal support for NPCs, and minimal support for player interaction (chat & player movement being mostly it).
updated README 2023-03-10 06:58:29 +00:00
started docker image 2023-06-20 07:12:15 +00:00			`Startup the environment using`

			```sh
			`$ chmod +x ./build.sh && ./build.sh`
			`$ docker compose up`
			```

better readme 2023-08-23 23:38:14 +00:00			`The environment consists of a shard service, login service, redis && postgres containers. redis is used to pass login metadata between the login and shard services, while postgres is just used to store player accounts and characters.`

started docker image 2023-06-20 07:12:15 +00:00			login server is hosted at `127.0.0.1:23000`, just join from your [favorite client](https://github.com/OpenFusionProject/OpenFusion/releases/latest)

updated README.md 2023-03-07 18:39:12 +00:00			`## Generating structures`

started docker image 2023-06-20 07:12:15 +00:00			Dump and decompile the `Assembly - CSharp.dll` assembly from the fusionfall main.unity3d, using a tool like [ilspycmd](https://www.nuget.org/packages/ilspycmd/). The full output source can then be passed to `genstructs.py` script located in `tools/`, which will handle scraping constants and calculating structure padding. See the script for details on usage.