drgomesp / midgarts

Multi-platform Ragnarök Online MMORPG client

Midgarts

Midgarts Client is an attempt to write a modern client implementation of the old classic Ragnarök Online game.

Current Screenshots:

Table of Contents

• Introduction (coming soon)
• TODO
• Dependencies
• Building & Running
• Tools
  • GRF Explorer
• Examples

Introduction

TODO

Please have a look at the open milestones:

Milestone	Description
Character Graphics	Everything related to rendering character sprites, including character attachments, sprite animations and such.
World Graphics	Everything related to world graphics, including 3D objects, terrain, water and lights.

Dependencies

1. CentOS/Fedora-like Linux Distros: SDL2{,_image,_mixer,_ttf,_gfx}-devel alsa-lib-devel libX11-devel libXcursor-devel libXrandr-devel libXinerama-devel mesa-libGL-devel libXi-devel libXxf86vm-devel

2. Arch Linux: pacman -S sdl2{,_image,_mixer,_ttf,_gfx}

3. MacOS:

brew install sdl2{,_image,_mixer,_ttf,_gfx} pkg-config

Building and Running

1. Generate and env file by copying the distributed (.env.dist) file:

cp .env.dist .env 

2. Make sure to alter the GRF_FILE_PATH variable on the .env file:

GRF_FILE_PATH=/path/to/data.grf

3. Build the main binary by running:

go build -o midgarts ./cmd/sdlclient/main.go 

4. Run the binary:

./midgarts

Tools

GRF Explorer

Latest screenshots:

Examples

Loading a GRF file

grfFilef, err := grf.Load("data.grf")

Getting an entry

grfEntry, err := f.GetEntry("data\sprite\ork_warrior.spr")

Loading SPR files

sprFile, err := spr.Load(e.Data)

Generating a PNG from a sprite

outputFile, err := os.Create("out/test.png")
if err != nil {
log.Fatal(err)
}

defer outputFile.Close()

if err = png.Encode(outputFile, img); err != nil {
log.Fatal(err)
}

midgarts's Issues

Animate sprites

GND file support

See https://github.com/Duckwhale/RagnarokFileFormats/blob/master/GND.MD for more context.

Generate spritesheets from sprite frames

There should be a way to generate a spritesheet that can be used with engo to improve the rendering performance of sprites.

GRF file support

This is already implemented, and the issue was created for documentation purposes only.

Support for Head middle attachment

Same as #9 but for mid head gear attachment.

GAT file support

See https://github.com/Duckwhale/RagnarokFileFormats/blob/master/GAT.MD for more context.

RSW file support

See https://github.com/Duckwhale/RagnarokFileFormats/blob/master/RSW.MD for more context.

SPR file support

https://github.com/project-midgard/midgarts/wiki/File-Formats-(Sprites)

2D Character Rendering

We need to support rendering of all kinds of character sprites, considering initially - but not limited to - the following requirements:

• Body
• Head and rest of sprites
• Character actions (idle, sit, walk, attack, etc) and their animations
• Directions

The current implementation in the examples shows a very naive way of rendering character sprites and how primitive they currently are, holding no state whatsoever (they are essentially just engo Entities with rendering and animation components that are dinamically built based on their action frames. This is how it currently looks like:

Support for Head top attachment

Same as #9 but for top head gear attachment.

Support for Head bottom attachment

See https://github.com/Duckwhale/RagnarokFileFormats/blob/master/ACT.MD#attachments for more info. Basically, we need to render the head gear (bottom part) and make sure all actions are working with it.