LeafSpringCog

LeafSpringCog is a fork of LandSandBoat, and is what the Claybodin server runs on. It differs from LSB in the folowing ways:

• Structured to build on and tested for running on Gentoo Linux as well as Ubuntu (LandSandBoat has "official" support for Ubuntu and Windows only). This is mostly for fun, but does serve the purpose of testing the project when built with newer versions of GCC and Clang than what Ubuntu LTS provides. Please note that this fork is intended to build on Linux only.

• Host a gameplay envorinment with specific changes from retail, including:

  • Many Ciphers that are normally rewarded from Login Campaign points have been changed to rewards from quests or missions that pertain to those characters. The roadmap is for all Trusts to be acquired via storyline method, rather than with currency, FoV, RoE etc. Claybodin does not run a Login Campaign.
  • Weapon/Magic skillups have been removed; characters are always at max skill for their level. I consider this to line up better with the other QoL changes implemented in the modern era.

Other changes may happen in the future.

Visit the LandSandBoat project page for more info. LeafSpringCog is licensed under GNU GPL v3.

Gentoo Install Guide

The below is for setting up your own server environment on Gentoo. If you just want to play, skip this section.

Ensure your system is up to date:

root # emerge --sync && emerge -avuDU @world

Emerge the following packages and their dependencies:

root # emerge -a dev-db/mariadb dev-lang/luajit dev-vcs/git net-libs/zeromq

Clone the repo in your folder of choice, then copy the settings files where they can be sourced:

user $ cd ~/ && mkdir git && cd ~/git 
user $ git clone --recursive https://github.com/claybie/LeafSpringCog.git
user $ cp LeafSpringCog/settings/default/* LeafSpringCog/settings

MariaDB will need to be configured and the database initialized before the service can be started. If you have issues, or are using systemd instead of OpenRC, refer to the wiki.

root # emerge --config dev-db/mariadb
root # rc-update add mysql default
root # rc-service mysql start

In order to use dbtool for managing your database, additional packages are required, one of which is not in the Gentoo repo. Upstream uses pip to install these packages, but that is not desired nor necessary on Gentoo. Thankfully with an overlay we can get what we need (ensure you have already installed and configured eselect-repository):

root # eselect repository add claytabase git https://github.com/claybie/claytabase.git
root # emaint sync -r claytabase

Now we can emerge all the packages we need to use dbtool:

root # emerge -a dev-python/black dev-python/colorama dev-python/GitPython dev-python/mariadb dev-python/pylint dev-python/pyyaml dev-python/pyzmq dev-python/regex

Additionally, you will also need to emerge the following Python packages if you wish to use pydarkstar as an automated auction house:

root # emerge -a dev-python/beautifulsoup4 dev-python/sqlalchemy

You may now otherwise follow the Quick Start Guide, continuing to set up your database with the instructions under:

Linux (Debian/Ubuntu 22.04)

Beginning with subsection:

Run the following script to improve database security:

Keep in mind any reference to the folder server should instead be LeafSpringCog if you built from this repo.

How To Play

• Install the client with Lutris on Linux. Windows users can download it here.

• Connect to the server address claybodin.org using Ashita.

  • You will need to edit Ashita's configuration to point to the LSB version of xiloader instead of the default bootloader; you can get it from the LSB xiloader Releases page.

• Improve the game's visuals with XI View 2.0 and AshenbubsHD Texture Pack.

Join the FFXiPrivateServers discord server for information on private servers, LandSandBoat development, client setup for Windows & Linux and more!