yurzs / l2py

Lineage2 server emulator written in Python3

L2py

Lineage2 Interlude+ server emulator written in python3

Stage: Alpha

What currently works

• Login Server
• Game Server

Contribute

Feel free to join developing our server:

• If you have some suggestions - please open an Issue.
• If you want to implement some features - check Project page.
• Or join our Discord server

How to start developing

• Copy .env.example to .env.
• Set environment variables as you need in .env

Using docker-compose

• Make sure you have make, docker, docker-compose installed.
• Build docker images make docker-build
• Start containers docker-compose up -d
• Register game server in database make compose-exec-login register_game_server <GAME_SERVER_HOST> <GAME_SERVER_PORT> <GAME_SERVER_ID>.
  NOTE: <GAME_SERVER_HOST> can't be 0.0.0.0

Without docker-compose

• Make sure you have make, docker, docker-compose installed.

• Install poetry using make install

• Run poetry install

• Start mongodb in container or using other methods.

• Activate virtual environment . .venv/bin/activate

• Register game server in database login/bin/register_game_server <GAME_SERVER_HOST> <GAME_SERVER_PORT> <GAME_SERVER_ID>
  NOTE: <GAME_SERVER_HOST> can't be 0.0.0.0

  NOTE: Apply environment variables with source .env

• Start login server make python -m login/login

• Start game server make python -m game/game

Emulator server architecture

Project is split to 2 components:

• Login Server - L2 login service + basic HTTP API
• Game Server - L2 game service + basic HTTP API

All those services have own instances of common.application.Application with specific modules (for example game server have TCPServerModule, HTTPServerModule, ScheduleModule).

ApplicationModules

Each ApplicationModule adds functionality to main application process. All modules are running in one asyncio loop.

• TCPServerModule: L2 protocol requests handler
• HTTPServerModule: HTTP JSON requests handler
• ScheduleModule: CRON tasks runner

TCPServerModule Middlewares

Middlewares are used in L2 protocol handler for convenient way for not caring about all those complicated protocol specific encryption.

Data types

Most of the custom data types derive from ctypes (At least numeric ones.)

l2py's Issues

L2PY-1: Implement Inventory

Required implementations:

• Item
• Inventory
• Static items data in JSON format
• Dropped Items document

Разработка

Привет, планируется ли возобновление разработки сервера?

Analyse bot tests

We need to test server somehow using automation.
Implementing a basic bot seems like a good start.
Need to analyse it in details.

L2PY-9: Switch dependency management to poetry

• Remove remnants of pip
• Switch to poetry instead
• Rewrite dockerfiles
• Rewrite Makefile
• Rewrite readme accordingly

Implement Items

L2PY-7: Create GitHub actions

Required checks for project:

• Formatter - black
• Imports - isort
• Linter - pylint

Implement Shortcuts

We need to implement shortcuts