Getting Started

» Home » Getting Started

In order to get started running RPKit on your server, there's a few things you need to sort out first. This will take a few server restarts, so it's best to get this all sorted out on a development server before loading everything on live.

First things first, install all the modules you wish to run and run the server once. This will generate configuration files.

Next, go to rpk-core-bukkit's config. There should be settings related to the web server and database:

database:
    url: jdbc:sqlite:rpkit.db
    dialect: SQLITE
web-server:
    port: 8089

By default, the database will be stored with SQLite in the file "rpkit.db" in the server root. This is fine for testing, but if you wish to run a production server, it's recommended you use a MySQL database.

To use a MySQL database, set the database URL, username and password to that of your database, and set the dialect to MYSQL. The schema and user should be created manually (many hosting providers do this for you) but the tables will be created automatically (and on upgrades, they will be migrated to the most recent versions if there are any changes).

database:
    url: jdbc:mysql://localhost/rpkit
    username: rpkit
    password: secret
    dialect: MYSQL
web-server:
    port: 8089

Your web server port should be set to a port that is free on the server. We recommend using a reverse proxy to provide SSL to your server - for example nginx or Apache with mod_proxy - and blocking external access to the port with a firewall, such as ufw. The web server will, however, function just fine without this, so for testing purposes you can use plain HTTP and access the web server directly, should you so require.

Once RPKit Core is set up, other plugins will be able to use it to facilitate the creation of tables. You may configure the other plugins you are using to your liking, and edit any messages (should you wish to run a server in another language, or change how certain things are referred to, for instance.)

Some plugins may also require some ingame setup, such as rpkit-characters requiring races to be created, or rpkit-economy requiring currencies to be created, so ensure everything that you wish to be working is working before running it on a live server.