Skip to content

Latest commit

 

History

History
44 lines (34 loc) · 1.56 KB

README.md

File metadata and controls

44 lines (34 loc) · 1.56 KB
Raw

NODE-FlyFF - Fly For Fun V19 Emulator

GPL-3.0 License

This project is licensed under the GPL-3.0 License.

Description

Node-FlyFF is an open-source project aiming to create a Fly For Fun (FlyFF) emulator using Node.js. It focuses on implementing game logic and networking for version 15 of the FlyFF game.

⚠️ This project is not affiliated with Gala Lab. ⚠️

Technical Information

  • Language: TypeScript (Node.js)
  • Node.js Version: 18 or higher
  • Application Type: Console
  • Database Type: SQLite, MySQL (SQLite for now)
  • Configuration Files Type: TBA (YAML or JSON)
  • Environment: Visual Studio Code, any Node.js compatible editor

Pre-requisite

  • Redis-server (Caching)
  • WSL (for windows development)
  • Node.js 18

Getting Started

Please refer to our contributing guidelines if you're interested in contributing to the project.

Before getting started, ensure you have the following software installed:

  • Node.js
  • Visual Studio Code or any Node.js compatible editor
  • Redis-server (Requires WSL for windows development)

Initial Setup

  1. Clone this repository.
  2. Install dependencies with yarn or yarn install.
  3. Set up your database (SQLite or MySQL) and configure the connection in the appropriate configuration file.
  4. Setup Redis Server. WSL
  5. Start the server with yarn dev [server] (login, cluster or world).

Contributors

License

This project is licensed under the GPL-3.0 License. See the LICENSE.md file for details.