FOnline Engine

Engine currently in semi-usable state due to heavy refactoring

Table of Content

• Features
• Usage
  • Public API
  • Setup
  • Package dependencies
  • Statically linked packages
  • Footprint
  • Tutorial
• Work in progress
  • Roadmap
  • Todo list (generated from source code)
• Repository structure
• Frequently Asked Questions
• About

Features

• Isometric graphics (Fallout 1/2/Tactics or Arcanum -like games)
• Multiplayer mode with authoritative server
• Singleplayer mode (one binary, no network connections)
• Supporting of hexagonal and square map tiling
• Prerendered sprites for environment but with possibility of using 3D models for characters
• Engine core written in C++ (supported C++17 and C++20)
• Flexible scripting system with varies supporting languages:
  • Native C++ coding
  • AngelScript
  • Mono C#
• Cross-platform with target platforms:
  • Windows (+UWP)
  • Linux
  • macOS
  • iOS
  • Android
  • Web
• Supporting of following asset file formats:
  • Fallout 1/2
  • Fallout Tactics
  • Arcanum
  • FBX (3D characters)
  • and common graphics formats like PNG or TGA

Important note: Not all from described above features are already implemented, for additional information look at 'Work in progress' section below.

Usage

Engine doesn't targeting to use directly but by as part (submodule) to your own project (git repo).
Repository contains source code of engine, third-party sources and build tools for composing all this and your stuff into final platform-specific bundles.
You build your game fully from source, there is no prebuilt binaries, full control over the process.
Todo: write about cmake workflow

Public API

Documents related to public API:

• Public API
• Scripting API

Scripting api automaticly generated for each project individually and api described in Scripting API is only basic.
See example of extended scripting api at FOnline TLA Scripting API.

Setup

General steps:

• Create your own project repo and link this repo as submodule
• Setup your own .cmake file with your game configuration
• Use main CMakeLists.txt jointly with your .cmake to build game

Reference project:

• FOnline: The Life After https://github.com/cvet/fonline-tla

Package dependencies

Following Linux packages will help us build game for target platforms.

• Common:
  clang clang-format build-essential git cmake python3 wget unzip
• Building for Linux:
  libc++-dev libc++abi-dev binutils-dev libx11-dev freeglut3-dev libssl-dev libevent-dev libxi-dev curl
• Building for Web:
  nodejs default-jre
• Building for Android:
  android-sdk openjdk-8-jdk ant

Build scripts download and install following packages:

• Emscripten - for building Web apps
• Android NDK - compilation for Android devices

List of tools for Windows operating system (some optional):

• CMake - utility that helps build program from source on any platform for any platform without much pain
• Python - needed for additional game code generation
• Visual Studio 2022 - IDE for Windows
• Build Tools for Visual Studio 2022 - just build tools without full IDE

List of tools for Mac operating system:

• CMake
• Python - needed for additional game code generation
• Xcode

Other stuff used in build pipeline:

• iOS CMake Toolchain
• msicreator

Statically linked packages

These packages included to this repository, will compile and link statically to our binaries.
They are located in ThirdParty directory (except dotnet, it's downladed by demand).

• AcmDecoder by Abel - ACM sound format reader
• AngelScript - scripting language
• Asio - networking library
• backward-cpp - stacktrace obtaining
• Catch2 - test framework
• GLEW - library for binding opengl stuff
• glslang - glsl shaders front-end
• Json - json parser
• SDL2 - low level access to audio, input and graphics
• SHA1 & SHA2 generators by Steve Reid and Olivier Gay - hash generators
• small_vector - vector with a small buffer optimization
• span - std::span implementation for pre c++20
• SPIRV-Cross - spir-v shaders to other shader languages converter
• tracy - profiler
• Theora - video library
• Vorbis - audio library
• {fmt} - strings formatting library
• Dear ImGui - gui library
• MongoC Driver - mongo db driver + bson lib
• libogg - audio library
• libpng - png image loader
• LibreSSL - library for network transport security
• rpmalloc - general purpose memory allocator
• ufbx - fbx file format loader
• unqlite - nosql database engine
• websocketpp - websocket asio extension
• zlib - compression library

Footprint

Despite on many third-party libraries that consumed by the whole engine one of the main goal is small final footprint of client/singleplayer output.
Aim to shift most of things of loading specific image/model/sound/ect file formats at pre publishing steps and later use intermediate binary representation for loading resources in runtime as fast as possible and without additional library dependencies.
This process in terms of fonline engine called Baking.
Also as you can see all third-party dependencies linked statically to final executable and this frees up end user from installing additional runtime to play in your game.
Todo: write about memory footprint
Todo: write about network footprint

Tutorial

Please follow these instructions to understand how to use this engine by design:

• Tutorial document

Work in progress

Roadmap

• FOnline TLA as demo game [done]
• Code refactoring [95%]
  • Clean up errors handling (error code based + exception based)
  • Preprocessor defines to constants and enums
  • Eliminate raw pointers, use raii and smart pointers for control objects lifetime
  • Fix all warnings from PVS Studio and other static analyzer tools
• AngelScript scripting layer [done]
• Documentation for public API [10%]
• API freezing and continuing development with it's backward compatibility [85%]
• Native C++ scripting layer [20%]
• Improve more unit tests and gain code coverage to at least 80% [15%]
• C#/Mono scripting layer [30%]
• DirectX rendering [done]
• Singleplayer mode [70%]
• Particle system [done]
• Metal rendering for macOS/iOS [1%]

Todo list (generated from source code)

• Common: make entities positioning free in space, without hard-linking to hex
• Common: add third 'up' coordinate to positioning that allow create multidimensional maps
• Common: use smart pointers instead raw
• Common: fix all PVS Studio warnings
• Common: SHA replace to openssl SHA
• Common: wrap fonline code to namespace
• Common: ident_t 8 byte integer
• Common: hash_t 8 byte integer
• Common: tick_t 8 byte integer
• Common: c-style arrays to std::array
• Common: use more noexcept
• Common: use more constexpr
• Common: improve BitReader/BitWriter to better network/disk space utilization
• Common: improve custom exceptions for every subsustem
• Common: temporary entities, disable writing to data base
• Common: move all return values from out refs to return values as tuple and nodiscard (and then use structuured binding)
• Common: split meanings of int8/char and uint8/byte in code
• Common: improve named enums
• Common: replace depedency from Assimp types (matrix/vector/quaternion/color)
• Common: improve automatic checker of STACK_TRACE_ENTRY/NO_STACK_TRACE_ENTRY in every .cpp function
• Common: pass name to exceptions context args
• Common: recursion guard for EventDispatcher
• Common: eliminate as much defines as possible
• Common: convert all defines to constants and enums
• Common: rework built-in string messages
• Common: optimize copy() to pass placement storage for value
• Common: const string& -> string_view after moving to C++20 (unordered_map heterogenous lookup)
• Common: schedule job repeat with last duration?
• ServerServiceApp: convert argv from wchar_t** to char**
• 3dAnimation: add interpolation for tracks more than two
• 3dStuff: move texcoord offset calculation to gpu
• 3dStuff: merge all bones in one hierarchy and disable offset copying
• 3dStuff: add reverse playing of 3d animation
• 3dStuff: process default animations
• 3dStuff: remove unnecessary allocations from 3d
• 3dStuff: incapsulate model animation callbacks
• Client: rework critters inventory updating
• Client: synchronize effects showing (for example shot and kill)
• Client: move targs formatting to scripts
• Client: fix soft scroll if critter teleports
• Client: make IfaceAnim scriptable object
• CritterHexView: fidget animation to scripts
• CritterView: incapsulate AttachedCritters
• DefaultSprites: incapsulate sprite sheet data
• DefaultSprites: Spr.size()
• HexView: incapsulate hex view fileds
• Keyboard: merge Keyboard into App::Input and Client/Mapper
• MapSprite: : incapsulate all sprite data
• ParticleSprites: optimize sprite atlas filling
• RenderTarget: optimize sprite atlas filling
• ResourceManager: why I disable offset adding?
• ServerConnection: automatically reconnect on network failures
• SpriteManager: optimize sprite atlas filling
• SpriteManager: convert FT_ font flags to enum
• SpriteManager: fix FT_CENTERY_ENGINE workaround
• SpriteManager: incapsulate sprite data
• SpriteManager: move fonts stuff to separate module
• SpriteManager: optimize text formatting - cache previous results
• TextureAtlas: optimize sprite atlas filling
• TextureAtlas: incapsulate texture atlas & atlas space node data
• Updater: support restoring file downloading from interrupted position
• Updater: add update file files checking by hashes
• AngelScriptScriptDict: rework objects in dict comparing (detect opLess/opEqual automatically)
• CacheStorage: store Cache.bin in player local dir for Windows users?
• CacheStorage: add in-memory cache storage and fallback to it if can't create default
• DeferredCalls: improve deferred calls
• Entity: improve entity event ExPolicy
• Entity: improve entity event OneShot
• Entity: improve entity event Deferred
• Entity: entity events map key to hstring
• EntityProperties: implement Location InitScript
• GeometryHelper: remove hex offset limit
• GeometryHelper: move all geometry helper methods to static
• Log: server logs append not rewrite (with checking of size)
• Log: add timestamps and process id and thread id to file logs
• Log: colorize log texts
• MapLoader: restore supporting of the map old text format
• Properties: add shrink_to_fit complex data for all entities to get some free space on OnLowMemory callback
• Properties: validate property name identifier
• Properties: restore quest variables
• Properties: don't preserve memory for not allocated components in entity
• Properties: pack bool properties to one bit
• PropertiesSerializator: maybe need some optional warning for unknown/wrong properties
• PropertiesSerializator: check if converted value fits to target bounds
• PropertiesSerializator: validate integer value to fit in enum range
• Settings-Include: remove hardcoded ResourcesDir in package.py
• Settings-Include: move HeadBone to fo3d settings
• Settings-Include: move LegBones to fo3d settings
• Settings-Include: move resource files control (include/exclude/pack rules) to cmake
• Settings: improve editable entries
• Timer: remove Timer class, use directly std::chrono instead
• Application: move all these statics to App class fields
• Rendering-OpenGL: make workarounds for work without ARB_uniform_buffer_object
• Rendering-OpenGL: remove GLEW and bind OpenGL functions manually
• AngelScriptScripting-Template: GetASObjectInfo add detailed info about object
• ClientCritterScriptMethods: improve run particles for 2D animations
• ClientCritterScriptMethods: improve animation callbacks for 2D animations
• MonoScripting-Template: set Mono domain user data
• MonoScripting-Template: get Mono domain user data
• ServerMapScriptMethods: notify clients about manual hex block
• AdminPanel: admin panel network to Asio
• ClientConnection: make auto-RAII locker for InBuf/InBufLocker writing/reading
• ClientConnection: incapsulate ClientConnection data
• Critter: incapsulate Critter data
• CritterManager: find better place for critter in square geometry
• CritterManager: don't remeber but need check (IsPlaneNoTalk)
• EntityManager: load global map critters
• Location: EntranceScriptBindId
• Location: encapsulate Location data
• Map: make movable checks without critter removing
• Map: optimize iterms radius search by using GetHexOffsets
• Map: optimize critters radius search by using GetHexOffsets
• MapManager: if path finding not be reworked than migrate magic number to scripts
• MapManager: make dynamic path growth and move max value to settings
• Networking: catch exceptions in network servers
• Player: restore automaps
• Player: incapsulate Player data
• Player: allow attach many critters to sigle player
• Server: validate player moving path
• Server: validate stop position and place critter in it
• Server: control max size explicitly, add option to property registration
• Server: verify property data from client
• Server: add container properties changing notifications
• Server: make BlockLines changable in runtime
• Server: don't remeber but need check (IsPlaneNoTalk)
• Server: maybe prohibit bulk creation of non-stacked items
• Server: improve ban system
• Server: run network listeners dynamically, without restriction, based on server settings
• ServerDeferredCalls: improve deferred calls
• EffectBaker: pre-compile HLSH shaders with D3DCompile
• EffectBaker: enable auto map bindings
• ImageBaker: swap colors of fo palette once in header
• Mapper: mapper render iface layer
• ParticleEditor: improve EmitterAttacher (2)
• ParticleEditor: improve ActionSet
• ParticleEditor: DrawSparkObject SPK::EmitterAttacher
• ParticleEditor: DrawSparkObject SPK::ActionSet
• ParticleEditor: DrawSparkObject SPK::SpawnParticlesAction

Repository structure

• BuildTools - scripts for automatical build in command line or any ci/cd system
• Resources - resources for build applications but not related to code
• Source - fonline engine specific code
• ThirdParty - external dependencies of engine, included to repository

Frequently Asked Questions

Todo: write FAQ

About

• Site: fonline.ru
• GitHub: github.com/cvet/fonline
• E-Mail: cvet@tut.by