Skip to content

Commit

Permalink
fix some outdated info in the contributor's handbook
Browse files Browse the repository at this point in the history
  • Loading branch information
3vorp committed May 26, 2024
1 parent 181494d commit a8d80d4
Show file tree
Hide file tree
Showing 3 changed files with 25 additions and 16 deletions.
2 changes: 1 addition & 1 deletion pages/manuals/branding-guidelines.md
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ Logotexts were designed for users to be able to use a logo and a wordmark at the
<img src="https://database.faithfulpack.net/images/branding/logotexts/plain_logotext.png" class="center" loading="lazy">
<i class="center">The Faithful logotext.</i>

Always make sure to put logotexts on plain or low-contrast backgrounds — readability can be negatively impacted with noisy backgrounds. Please also note that the text and the logo that make up the logotexts are inseparable — don't use the pixel art text by itself.
Always make sure to put logotexts on plain or low-contrast backgrounds — readability can be negatively impacted with noisy backgrounds. Please also note that the text and the logo that make up the logotexts are inseparable, so don't use the pixel art text by itself.

<img src="/images/pages/manuals/branding-guidelines/logotext_comparison.png" class="center" loading="lazy">
<i class="center">Top: Correct placement of a logotext that ensures it's easily readable. Bottom: Poorly placed logotext.</i>
Expand Down
29 changes: 19 additions & 10 deletions pages/manuals/contributor-handbook.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,27 +5,30 @@ date: "2022-03-23"
---

# The Faithful Contributor's Handbook

#### *A step-by-step guide on how to create and submit textures for Faithful, and vote on them afterwards*

*If you’re reading this, you’ve most likely decided to help Faithful out and make a texture! For that, we sincerely thank you. Faithful is a fully community-run project, and wouldn’t be able to exist without volunteers like yourself!*

Now, let's get started.

## Creating Textures
Before you begin, we highly recommend reading our guidelines [here](/pages/textures/f32-texturing-guidelines) (for Faithful 32x) or [here](/pages/textures/cf32-texturing-guidelines) (for Classic Faithful 32x), as every texture in Faithful needs to follow them. The guidelines also contain a lot of handy texturing tips that you might find useful later down the path.

Before you begin, we highly recommend reading the texturing guidelines for the pack being contributed to, as every texture in Faithful needs to follow them. You can find these either with the `/guidelines` command on Discord or on this site in the "Textures" category. The guidelines also contain a lot of handy texturing tips that you might find useful down the line.

If you’re looking for a good program for pixel art, here’s what some of our best artists use:
- **Aseprite (paid, but free if you compile it from source yourself – [useful tool](https://github.com/TheLiteCrafter/AsepriteTool/releases/), [video tutorial](https://youtu.be/4amv2bAWJAA))** – Made specifically for pixel art. Offers useful options like several tiling modes and easy palette manipulation.
- **Paint.net (also known as PDN; free)** – An all-purpose image manipulation program, easy to learn, but only works on Windows.
- **GIMP (free)** – More capable than Paint.net, doesn't require Windows, but harder to learn for beginners.
- **Photoshop (paid)** – Expensive without an already existing license, however this works for basically everything.

To help you choose a texture to make, use the `/missing` command in [#bot-commands](https://ptb.discord.com/channels/773983706582482946/794137845408595978) to list textures that Faithful is lacking for a given version. Those are needed the most, but you can, of course, edit or re-make an existing texture as well if you so please.
To help you choose a texture to make, use the `/missing` command to list textures that Faithful is lacking for a given version and edition. Those are needed the most, but you can still edit or remake an existing texture as well if you so please.

Finally, during the creation of your texture, we recommend that you share your progress in [#texture-discussion](https://ptb.discord.com/channels/773983706582482946/773987767989305385). This will allow for others to give feedback and help you improve your texture before submission.
Finally, during the creation of your texture, we recommend that you share your progress in the project's #texture-discussion channel. This will allow for others to give feedback and help you improve your texture before submission.

## Formatting a Submission
Once you’re done with your texture, submit it by uploading a PNG file in the proper channel. Make sure the file name is exactly the same as the name of the texture in the game files! If you're looking for which channel submits to which project, here's a handy guide:

Once you’re done with your texture, submit it by uploading a PNG file in the proper channel. Make sure the filename is exactly the same as the name of the texture in the game files! If you're looking for which channel submits to which project, here's a handy guide:
- [#32x-submit-textures](https://discord.com/channels/773983706582482946/773987409993793546) – Faithful 32x
- [#64x-submit-textures](https://discord.com/channels/773983706582482946/931887174977208370) – Faithful 64x
- [#32x-submit-jappa](https://discord.com/channels/814198513847631944/814201529032114226) – Classic Faithful 32x Jappa
Expand All @@ -36,15 +39,19 @@ The former two are on the [main Discord](https://discord.gg/sN9YRQbBv7), and the

You can additionally upload multiple textures in one message if you made an entire set of textures, such as wool or planks, and attach a comment to your submission by sending a text message with the texture.

If you’re submitting a texture with a name that is present more than once in the vanilla files (such as `acacia.png`, which is both a sign texture and a boat texture), please hold for a bit after sending your message – the bot will ask you to clarify which texture you’re submitting. Choose the correct one by reacting to the bot message.
If you’re submitting a texture with a name that is present more than once in the vanilla files (such as `jungle.png`, which is the name of a villager, sign, and boat texture), wait for a bit after sending your message. The bot will ask you to clarify which texture you’re submitting with a dropdown menu.

If there are many textures with the same filename and you don't want to deal with the dropdown menus, you can also submit by texture ID (the numbers in front of the texture name in embeds or on the gallery). For instance, if your texture's filename is `307` or you include `[#307]` in your submission comment (with the square brackets and hashtag to prevent normal numbers in comments getting flagged), found textures will be overridden and texture 307 (dirt) will instead be submitted.

## Crediting Co-authors
## Crediting Contributions

ANY reused part of an existing Faithful texture should be credited in your submission. Additionally, if you’ve collaborated with someone else while making the texture, credit the co-author(s) as well. Ping all co-authors in your submission comment for the bot to add them automatically. If you're simply tweaking an existing texture, start your submission description with a plus sign (+) to add all the previous co-authors to the texture automatically.
Any and all reused parts of an existing Faithful texture should be credited in your submission (you can find who made a texture using the `/texture` command). Additionally, if you’ve collaborated with someone else while making the texture, credit the co-author(s) as well.

Alternatively, you can find out exactly who made which texture by searching for it using the `/texture` command or by using our web app gallery. If you see plain text rather than a Discord ping in the `/texture` embed, this is a user who is no longer in the Discord server. To credit them, you can surround their name in curly brackets, so the bot can detect you're trying to add this user as a co-author. For example, "Fixed a false line. Credit to {Author} for the original texture." would credit Author. This syntax also works for users who are in the server, but it's usually easier to just directly ping them (if credits for a texture are missing, you don’t need to worry about any of this).
In the submission comment, simply surround each co-author's username in curly brackets, so the bot can detect them as a contributor. For example, "Fixed a false line. Credit to {Author} for the original texture." would credit Author. If you're simply tweaking an existing texture, prefix your submission description with a plus sign (+) to add all the previous co-authors to the texture automatically.

You can delete your submission at any time by clicking the arrow icon below your submission, waiting for the bot to finish reacting, then click the trash bin icon. Additionally, if you ever want your texture removed from Faithful after it has passed voting and been added, message the Managers and they will remove your texture.
One thing to note about using curly brackets is that the name is based on the user's web app profile, not their Discord username. If these are different, or you don't want to go through the trouble of finding the correct username, you can alternatively ping the author in the comment to add them as well — both methods work in exactly the same way besides the former saving a ghost ping. If credits for a texture are missing, you don’t need to worry about any of this.

You can delete your submission at any time by clicking the arrow icon below your submission, waiting for the bot to finish reacting, and reacting with the trash bin icon. Additionally, if you ever want your texture removed from Faithful after it has passed voting and been added, message a manager or council member and they will remove your texture.

Finally, please know that by submitting a texture, you agree to allow:
- The texture to be used in any public or development version of Faithful.
Expand All @@ -53,7 +60,9 @@ Finally, please know that by submitting a texture, you agree to allow:
- Others to edit your texture without any required prior notice, and allow them to submit the edited texture to Faithful, with appropriate credit.

## Voting on Textures and the Texture Approval Process

Whether a texture makes it into Faithful or not is determined by a voting process. It consists of two stages:

1. **Community Voting:**
On the main Discord, this period lasts for 2 days and is open to everybody. For Classic Faithful, this period lasts one day. To vote on a submission, simply click on the check mark ✅ or cross ❌ button depending on whether you like the texture or not. Before you vote however, keep in mind that you should do the following:
- **Clearly view the texture:** You should always get a clear look at the texture before voting on it. The size of the texture you see in submissions can sometimes be too small and compressed to actually view. Thankfully, the bot is equipped with tools that you can use to get a better view of the texture. You can click on the magnifying glass button to view the texture more closely (this button is also a command in the form of `/magnify`).
Expand All @@ -68,7 +77,7 @@ Whether a texture makes it into Faithful or not is determined by a voting proces

A texture passes council voting if it has more upvotes than downvotes after one day. The council’s decision is final – if the council rejects a texture, it will never be added to the pack and the same, unmodified one cannot be submitted again.

Besides the upvote and downvote options regular users get, there are 2 other options that the council and Managers have:
Besides the upvote and downvote options regular users get, there are 2 other options that the council and managers have:

1. **Instapass**: An instapass is when a texture immediately gets added into the pack without needing to go through the voting process. These textures usually get instapassed for reasons such as being recolours of another texture, consistency fixes for textures that are outdated, or even bugs that needed fixing.

Expand Down
10 changes: 5 additions & 5 deletions pages/manuals/expanded-server-rules.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ date: "2022-10-23"
---

<!--
Template for adding new entries if you're lazy like me:
Template for adding new entries:
<br>
<li><b></b> - </li>
<ol class="lettered">
Expand All @@ -21,11 +21,11 @@ Template for adding new entries if you're lazy like me:
<i>
As long as the Faithful Discord servers have existed, there have been one set of rules. They have a description of what to do, what not to do, and nothing more. While this sounds pretty standard for most Discord servers at first, the problem is that the interpretation of these rules can be entirely up the moderator or moderators online at any given time.
<br><br>
A system like this for us ended up resulting in a plethora of hasty decisions made on the spot. Long arguments between moderators would drag on over fuzzy rule boundaries, all stemming from punishments made hours before. In addition, there was little to no transparency as to how decisions were made — decisions would often be reversed hours after they were made with no explanation as to why. All of this ended up with the alienation of the community from the moderation staff users would seemingly get punished for no reason after just making a joke, and the moderation team wouldn't give any insight as to why.
A system like this for us ended up resulting in a plethora of hasty decisions made on the spot. Long arguments between moderators would drag on over fuzzy rule boundaries, all stemming from punishments made hours before. In addition, there was little to no transparency as to how decisions were made — decisions would often be reversed hours after they were made with no explanation as to why. All of this ended up with the alienation of the community from the moderation staff, as users would seemingly get punished for no reason after just making a joke and the moderation team wouldn't give any insight as to why.
<br><br>
However, this problem went far further than the moderation staff and rule interpretation itself. This was a systematic problem across the entirety of Faithful, leading to an endless dilemma over how the rules should be interpreted. Moderation exists to keep the server a welcoming and civilized place, but if punishments go too far, moderation becomes meaningless and nobody wants to be on the server in fear of retribution over a simple joke. However, swing too far the other way and the Discord becomes a lawless mess where nobody takes the rules seriously and nobody can take action when necessary.
<br><br>
Transparency is one of our key factorsplaying into the open sourced aspect of Faithfuland the community is Faithful's biggest asset. The more inviting the staff and the server can be, the better everything will end up as a result. Knowing the distinction between stern and unapproachable is essential to maintaining this — you may have noticed us ditching overly formal language in the past few months in favor of more human-readable content (e.g. the license update). Keeping all of this in mind has been central to our thought process that made us decide to fix the true source of the problemthe server rules. By removing the need for constant interpretation of the rules with inbuilt guidelines for dealing with the most common rule breaks, everyone ends up better the community gets a much more consistent and sympathetic moderation team, and the moderators don't have to deal with constant arguments over specific rule clauses.
Transparency is one of our key factors, playing into the open sourced aspect of Faithful, and the community is Faithful's biggest asset. The more inviting the staff and the server can be, the better everything will end up as a result. Knowing the distinction between stern and unapproachable is essential to maintaining this — you may have noticed us ditching overly formal language in the past few months in favor of more human-readable content (e.g. the license update). Keeping all of this in mind has been central to our thought process that made us decide to fix the true source of the problem: the server rules. By removing the need for constant interpretation of the rules with inbuilt guidelines for dealing with the most common rule breaks, everyone ends up better, as the community gets a much more consistent and sympathetic moderation team and the moderators don't have to deal with constant arguments over specific rule clauses.
<br><br>
That's not all. While this document was originally intended to be used only by the moderation staff and just contain punishment guidelines, we eventually realized that making it public would be a far better idea. Not only would ban appeals and rule clarifications fit in perfectly, but users would know exactly the reasoning for their punishment and could even suggest changes if the vast majority considered a certain rule or punishment inappropriate. While the new rules take an overall more lenient approach, which the majority of users (taken from our moderation poll made few months prior to the rewrite) wanted, some things were disallowed due to many people requesting it.
<br><br>
Expand Down Expand Up @@ -97,7 +97,7 @@ Template for adding new entries if you're lazy like me:
<li>If done to cause harm, ban and report the user.</li>
</ol>
<br>
<li><b>Being unable to respect people's identity</b> - Intentional misgendering, inflammatory comments, and generally rude comments towards one's identityeven those that aren't outright hate speech — are disallowed under all circumstances.</li>
<li><b>Being unable to respect people's identity</b> - Intentional misgendering, inflammatory comments, and generally rude comments towards one's identity, even those that aren't outright hate speech, are disallowed under all circumstances.</li>
<ol class="lettered">
<li>Between a short mute and ban depending on context and the severity of actions.</li>
</ol>
Expand Down Expand Up @@ -237,7 +237,7 @@ Template for adding new entries if you're lazy like me:
<li><b>Advertising without context</b> - Resource packs are allowed within reason, however don't overdo it.</li>
<ol class="lettered">
<li>Delete the offending content and verbal warn the user not to do it again. Repeat offenses will lead to a mute and ban.</li>
<li>This includes doing transactions with real-life money — take these topics to DMs or a more suitable place.</li>
<li>This includes doing transactions with real-life money. Take these topics to DMs or a more suitable place.</li>
</ol>
<br>
<li><b>Spamming/DM advertising</b> - This also includes any sort of inappropriate advertising or scams.</li>
Expand Down

0 comments on commit a8d80d4

Please sign in to comment.