L2Apf

Lineage 2 C4 artificial player / framework (alpha).

You can implement desired behavior right inside entry script or use higher-level programs interface or connect actions/models/events to your neural network.

Requirements

Racket language (version 6 or newer).
- Packages: srfi-lite-lib, r6rs-lib, yaml.
L2J Chronicle 4 server & datapack.
Lineage 2 Chronicle 4 installer & protocol 656 update.

Programs

Program is a potentially reusable algorithm that can be instantiated with parameters and shares state between iterations.

Iteration can be caused by a server event, custom event or timer event.

Program can be finite or not. Can be foreground or background. Only one foreground program can handle an iteration event but previous programs can be stacked on load.

Examples

Raid on Madness Beast.

Run minimalistic entry script for solo player:
racket -O 'debug@l2apf' player.scm.

Run a party of players (you are leader):
racket -O 'info@l2apf' _sdk/realm.scm config.yaml party.hunt.

player.scm

#lang racket
(require
	db/sqlite3
	"library/extension.scm"
	"system/structure.scm"
	"system/connection.scm"
	"system/event.scm"
	"system/debug.scm"
	"model/object.scm"
	"api/say.scm"
	(only-in "program/brain.scm"
		make-brain
		(brain-run! run!)
		(brain-load! load!)
		(brain-stop! stop!)
	)
	"program/idle.scm"
	"program/print.scm"
	"program/partying.scm"
	"bootstrap.scm"
)

(global-port-print-handler apf-print-handler)
(define db (sqlite3-connect #:database "apf.db" #:mode 'read-only))
(let-values (((cn wr me events) (bootstrap "localhost" 2106 "account" "password" "name" db)))
	(define br (make-brain cn (make-program-idle)))
	(load! br
		(make-program-print)
		(make-program-partying)
	)

	(do ((event (sync events) (sync events))) ((eq? (car event) 'disconnect))
		; Triggers space.
		(case-event event
			; Standard events.
			('creature-create (id) ; Unhide builder character on login.
				(when (and (= (object-id me) id) (> (ref me 'access-level) 0))
					(say cn "hide off" 'chat-channel/game-master)
				)
			)

			; Custom events.

		)

		; Programs space.
		(run! br event)
	)
)

config.yaml

host: "localhost"
password: "123456"
party:
  hunt: [doc, grumpy, happy]
  raid: [bashful, sleepy, sneezy, dopey]

* Some pieces of code may be outdated or not fully implemented but I sustain operability of core and basic flow.

Extension

You can implement missed packets/actions/events or update the project to higher server version with ease. You can even port this architecture to another game.

How to write a program

Start with:

(define (make-my-program)
	(make-program 'my-program
		(lambda (connection event state)
			; ...
		)
	)
)

Full syntax:

(define (make-my-program config-param1 . config-paramN)
	(make-program 'my-program
		(lambda (connection event state) ; Program iterator.
			; ...
		)
		#:constructor (lambda (connection) ; On load callback.
			; ...
		)
		#:destructor (lambda (connection state) ; On unload callback.
			; ...
		)
	)
)

For non-commertial use. In case of public use please indicate URL of original repo (https://github.com/EligiusSantori/L2Apf).