!!INFO!!
As
@Dibutello kindly pointed out my mindset about the bugreport system and its advantages didnt take into consideration that some of you might never have dealt with github in the first place and might not understand why we didnt chose a forums bug reporting. So i'd like to rectify this by presenting properly how things are setup currently and also point to the areas of interest for you as a player/interested contributor.
Lets start with showing you where your bugreports go to and what the github provides:
This is how it looks when you click the github link in the OP (original post or also first post).
github is basically meant to support a developer organisation in the daily tasks of changing code across several people but is also meant for documentation of the code or concepts itself.
It more or less provides all the necessary tools and functions for a successful collaboration on the development level. Only a few parts are interesting for the common user though which i highlight here:
From top and left to right and then to bottom those areas are:
Issues is the github word for everything that is an issue for the development. This is where your
bugreports and
feedback goes to. As posting into it usually requires the user to have its own github login and we are talking about a sex game where not everybody is comfortable to be in the open we decided for a better way that allows all of you to
stay anonymous - thus the ingame bugreporting via GitReports. Each report becomes an issue in our github automatically and we have a direct integration with our discord that notifies us immediately about new ones or changed ones. As the issues list can be seen by
everyone without a login tracing the status of your own reports and others becomes very simple. It actually looks like this:
All the grey 'user bug' ones are reports that where send by you fine users. We look at them and might change their classification to an actual bug, an enhancement, a future feature etc.
Next on the list we have the
Wiki. This is
not a game wiki (we do that kind of stuff directly in the game) but a wiki that explains and describes the actual mechanics in the code, concepts of what we change or implement etc. It is the main area for everyone to look at who has interest in helping with the mod and is also the baseline for our own work. The main tragedy with the original was that actual documentation for anything code related was disappearing in the midst of answered questions, many different development threads or it wasnt documented at all for the outside. This part aims to change that.
That leaves us with Qgen and the famous splitter tool. Our main goal was and has always been to enable you - the community - to access the code and/or contribute with content like events and quests. To edit the code we continue to recommend using QGen whenever possible as it allows for more secure editing than any outside editor can. Since
we also translated the help (special thanks to @Quacker) QGen will show you appropriate hints about command structure and command parameters in the QGen editor.
The
splitter programme is a wonderful tool made by
@Oiz with
simplicity and ease of use in mind. It will help you as the
average contributor or coder to split the big text export into single file where each code location becomes a single file. It also does the exact opposite and lets you merge all the sub-files into one big text file again which then can be transformed back into a regular qsp file with one simple command.
I do hope this makes things a lot clearer and please dont hesitate to let us know if something is unclear or confusing - one of our most important goals is enabling everyone in the community to become a contributor and not to make this a closed one for an elite group.