Getting started - for developers

Game configuration tutorials, addons and macros.

Getting started - for developers

by Daemon » Sat Apr 02, 2016 11:28 pm

Dear community,

The currently running PTR realm and final Nostalrius TBC realm will be based on an open source emulator, publicly available here:

Open source contributors and official team members
We are actively looking for open source contributors, and official team members.
In order to be part of the official team, you will have to have already contributed to our repositories, as an open source contributor. The role of the official team is to handle code submissions (mainly through Pull Requests), to give main development axis, and to decide high level implementation choices. They are required to be available a minimum number of hours per week, as our developers for the vanilla team.

Open source contributors do not have any requirement regarding their availability, and are not expected to provide support for their accepted fixes. They are encouraged to follow bug priorities, but can also contribute to fix any bug they want to.
As open source contributor, you will have to work on our code base, following scripting good-practice, and improve your code according to peer reviews.

We see it as a unique opportunity:
  • To gain valuable coding experience on a large project,
  • To improve the quality, efficiency and robustness of your code,
  • To get a first experience of open source coding,
  • To work on a product which will be used by thousands of players in the future

How to join the open source contributors? How do I get started?
The first step to get started would be to join our Discord server to be able to discuss with other team members / open source contributors.
Once you have read this post entirely, send me a PM stating that you want to get access to the Discord. You do not need to send a complete application, a short presentation will be fine. However, you need to have at least one message on the forums in order to be able to PM me (feel free to answer this topic).

The second step will be to setup your own copy of the emulator on your computer to effectively make changes. Do not worry, it is not that hard, and we will be there on the Discord to help you!
There are 2 ways you can setup a server:

At this point, you should be able to login on your own server, and modify it as you want.

How do I submit my modifications?
I won't go into details here, but here are the main steps:
  • Register a Github account, if you don't have already one
  • Fork the repository you would like to contribute to (Core for example)
  • clone this repository on your own computer
  • Create a new branch, work, and commit your fix on this branch
  • Push this branch to your repository
  • Go to github, to your branch, and you will be able to submit a pull request
  • Wait for your pull request to be accepted. Automated tests will also be run to make sure your change does not break any functionality. People may answer you with comments about your code, and discuss implementations

Thank you in advance for your contribution, and we hope that you will enjoy working on this huge project that is Nostalrius TBC!

Daemon - Nostalrius dev team leader.
User avatar

Re: Getting started - for developers

by Fridolin » Sun Apr 03, 2016 3:09 am

Thanks for the Post Daemon :)!
Nostalrius PvP
Alliance Mage :)

Developing an AddonManagementTool for Vanilla and TBC Addons!
User avatar
Senior Sergeant
Senior Sergeant

Re: Getting started - for developers

by Synchronize » Sun Apr 03, 2016 6:33 am

I've been looking for an open source c++ project for some time now, and NostalriusTBC seems to be a great opportunity. I'm looking forward to contribute. Will PM shortly.

Re: Getting started - for developers

by orfasanti » Mon Apr 04, 2016 11:50 am

Compiled the core on *nix.
Manually importing the SQL data because I do not understand how to configure the shell script.
It does not matter what parameters I set, the script cannot find any of my directories.

(getting an error with the 1.4.2 core character update)
Code: Select all
ERROR 1054 (42S22) at line 5: Unknown column 'required_s1350_11716_09_characters_mail' in 'character_db_version'

anyways, I'll find a solution eventually...

Currently importing Nostalrius SQL data and I should be able to execute a head momentarily.

Will PM once I am fully operational

EDIT: up and running but still no idea on how to solve the 1.4.2 core character update import error
User avatar

Return to Getting started