👍🎉 First off, thanks for taking the time to contribute! 🎉👍

The following is a set of guidelines for contributing to the Remake of LifePlay adult game hosted on GitHub. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.

Code of Conduct

This project and everyone participating in it is governed by Raddeck Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to Raddeck, in private.

I don’t want to read this whole thing I just have a question!!!

Note: Please don't file an issue to ask a question. You'll get faster results by using the resources below.

We have an official Wiki with some detailed FAQ and where the project chimes in with helpful advice if you have questions. RaiderKnight Mods Wiki

If chat is more your speed, you can join the RaiderKnight server on Discord: Even though Discord is a chat service, sometimes it takes several hours for project members to respond — please be patient!

• Use the #rules – Rules and general information.
• Use the #workflows – Announcements related to my projects.
• Use the #general – Main chat for all topics, try to keep images to a minimum.
• Use the #saloon – For chatting about anything.
• Use the #support – Support channel for help about my mods.
• Use the #ideas-and-feedback – To give ideas and feedback about my mods.
• Use the #find-a-bug – To report a bug about my mods.
• Use the #coding-room – Chat for talking about programming.
• Use the #patrons-saloon – For chatting between patrons, suggestion or else.

There are many other channels available, check the channel list on #rules

What should I know before I get started?

Rules for contributing in the Remake of LifePlay

How to edit/create files for the Remake of LifePlay

For the moment, Raddeck, the project administrator, he’s the only one who are in charge of editing the files (more than 1500) and adding contributions to the project.

When we make a significant decision in how we maintain the project and what we can or cannot support, we will document it in the #lp-remake-decisions channel. If you have a question around how we do things, check to see if it is documented on RaiderKnight Discord server or LifePlay Community Forums. If it is not documented there, please open a new topic on Discord or Github and ask your question.

Most important rules before joining as an artist, modder or writer

• You need to be at least 18 years old or older.
• You need to be an artist, a modder or a writer.
• You need to join the RaiderKnight Discord server (no obligations but if you want news…).
• You need to show your work.
• If accepted, you will have access to #lp-remake channels.
• Once in place, your contribution cannot be deleted.¹
• You accept to give your contribution to the project.¹

Notes1: Your contribution will be edited by all modders participating in the project.

How Can I Contribute?

– As a fan, player, other:
– Reporting Bugs – on Discord – Github – LifePlay Community Forums
– Suggesting Enhancements – on Discord – LifePlay Community Forums
– Sharing tutorial or documentation – on LifePlay Community Forums
– Your First Code Contribution – on Discord – LifePlay Community Forums
– Pull Requests – on Github
– Supporting my works – on Patreon

By joining the project

– As an artist:
Show off some creations that you think LifePlay gamer would like and who will fit with the story in place!

– As a modder:
Show me the files you have created for the Remake of LifePlay.

– As a tester:
Find typos or fixing texts, find bugs or dead ends, help us to set better values on each actions,…

– As a writer:
Create a story who fit with the Remake of LifePlay universe and I or we will make the coding!

If I refuse your contribution, don’t be upset, maybe:

• Your story already exist or is too short.
• You overestimated the power of the game.
• Your story have too many elements, that it will take a year to code.
• Your coding is so bad, that I have to remake it.
• Your mod don’t have enough actions/content/consequences,…
• Others.

By reporting bugs

This section guides you through submitting a bug report for the Remake of LifePlay. Following these guidelines helps maintainers understand your report 📝, reproduce the behavior 💻 💻, and find related reports 🔎.

Before creating bug reports, please check the list associated with the mod you have problem with, as you might find out that you don’t need to create one. When you are creating a bug report, please include as many details as possible. Fill out the required template, the information it asks for helps us resolve issues faster.

Note: If you find a Closed issue that seems like it is the same thing that you're experiencing, open a new issue and include a link to the original issue in the body of your new one.

Before Submitting A Bug Report

• Visit the LifePlay Community Forums.
• Check if the bug exist in the list, to see if the problem has already been reported.
• Determine which repository the problem should be reported in
• Double check your setup

How Do I Submit A (Good) Bug Report?
Bugs are tracked as GitHub issues. After you’ve determined which repository your bug is related to, create an issue on that repository and provide the following information by filling in the template.

• Use a clear and descriptive title for the issue to identify the problem.
• Describe the exact steps which reproduce the problem in as many details as possible.
• When listing steps, don’t just say what you did, but explain how you did it. For example, if you used the player to do an action, explain if you used the menu, or a keyboard shortcut or it was automatic, and if so which one?
• Provide specific examples to demonstrate the steps. Include links to files, or copy/pasteable snippets, which you use in those examples.
• Describe the behavior you observed after following the steps and point out what exactly is the problem with that behavior.
• Explain which behavior you expected to see instead and why.
• If possible, Include screenshots and animated GIFs which show you following the described steps and clearly demonstrate the problem.

If the problem wasn’t triggered by a specific action, describe what you were doing before the problem happened and share more information using the guidelines below.

Include details about your configuration and environment:

• Which version of LifePlay are you using?
• What’s the name and version of the mods do you have installed?

Suggesting Enhancements

This section guides you through submitting an enhancement suggestion for the Remake of LifePlay, including completely new features and minor improvements to existing functionality. Following these guidelines helps maintainers and the community understand your suggestion 📝 and find related suggestions 🔎.

Before creating enhancement suggestions, please check on Discord (#ideas-and-feedback) as you might find out that you don’t need to create one. When you are creating an enhancement suggestion, please include as many details as possible. Fill in the template, including the steps that you imagine you would take if the feature you’re requesting existed.

Before Submitting An Enhancement Suggestion

• – Visit #ideas-and-feedback on Discord, to see if someone has made the same suggestion.
• – Double check your suggestion

How Do I Submit A (Good) Enhancement Suggestion?
Enhancement suggestions are tracked as GitHub issues. After you’ve determined which repository your enhancement suggestion is related to, create an issue on that repository and provide the following information:

• Use a clear and descriptive title for the issue to identify the suggestion.
• Provide a step-by-step description of the suggested enhancement in as many details as possible.
• Provide specific examples to demonstrate the steps. Include copy/pasteable snippets which you use in those examples, as Markdown code blocks.
• Describe the current behavior and explain which behavior you expected to see instead and why.
• Include screenshots and animated GIFs which help you demonstrate the steps or point out the part of LifePlay which the suggestion is related to.
• Explain why this enhancement would be useful to most LifePlay users and isn’t something that can or should be implemented as a mod.

Your First Code Contribution

Unsure where to begin contributing to the Remake of LifePlay? You can start by looking through these beginner and help-wanted issues:

• Ask your questions on Discord – #support or #coding-room channel.
• Visit the LifePlay Community Forums for all the documentation.
• Read: Rules for contributing in the Remake of LifePlay.
• Learn: How to edit/create files for the Remake of LifePlay
• Double check your codes before sharing

Important, helps are only reserved to contributors or modders who needs help or for creating mod for the Remake of LifePlay.

Coding conventions
Follow LifePlay coding conventions included in each version of LifePlay.
Consider the modders who will read your code, and make it look nice for them.

Pull Requests

The process described here has several goals:

• Maintain the Remake of LifePlay’s quality
• Fix problems that are important to users
• Engage the community in working toward the best possible Remake of LifePlay
• Enable a way for the Remake of LifePlay’s maintainers to review contributions

Please follow these steps to have your contribution considered by the maintainers:

• Follow all instructions in the template
• Follow this styleguide for contributing on the Wiki.
• Follow this styleguide for contribution via Github.
• After you submit your pull request, verify that you fill all question in the template

While the prerequisites above must be satisfied prior to having your pull request reviewed, the reviewer(s) may ask you to complete additional codding work, tests, or other changes before your pull request can be ultimately accepted.