Creating A Community Pack [HIDDEN]

• You MUST NOT sell or trade for profit any assets created and owned by SWEM
  → Modified versions of the horse model
  → Modified versions of any blocks or items
  → Modified version of any default coats
  → Modified textures of any blocks or items
  → Shading layers
  → Free materials: template resource packs, template community packs, json files (not in a working community pack)
  
  
• You can provide FREE content that accepts an OPTIONAL donation
  → Includes modified horse models (ie resource pack override to add-on "breeds")
  → Does not include default coat modifications without explicit permission
  
  
• You MUST NOT modify, re-upload, or sell the work of creators without consent / allowed by TOU.
  → Includes the Official Community Pack (free) featuring donated works from community artists
  
  
• You can sell content that is at least 90%* your own work
  → Models for entities, blocks or items
  → Textures for entities, including coats using the freely provided shading layer or standard features (eyes, nose, hoof etc)
  → Textures for blocks or items
  → Animations 
   * 90% accounts for the 10% which can be accredited to fair inspiration, reference or color picking.
  
  
• You MUST NOT sell, promote or feature SWEM in any custom content or media that includes:
  → Extreme violence or gore
  → 18+ content or mature themes

Star Worm Equestrian is and always will be age appropriate to all users (PG13).
Any content or creators that modify it to be otherwise do so outside the terms of use of this project.

WARNING

Creating a complicated or highly restrictive TOU will set you up for frustration when it is inevitably violated or misinterpreted.
To protect your content within the very limited legal recourse for TOUs we encourage creators to share their creations in a similar way to mods; allow public or private use with minimal restrictions, provided the creator receives the download or support.

• If you choose to share your content publicly, it is your responsibility to clearly inform users of appropriate use.
• It is unreasonable to expect users to be remain informed of alterations to TOU after the time of download.
• It recommended to:
  → Post your full TOU in a public source that can be accessed by anyone without membership or sign up/in.
  → Include your TOU as a text file in any premade community packs.
  → Include your TOU as a link or summary in any location your files are hosted or downloaded.
  

RECOMMENDATIONS

Avoid requiring credit for use in media; it should be encouraged but no credits does not equal insult!
→ It is not standard practice to credit every creation (ie mods) in casual images; nice if you do, but optional!
→ It should only be "required" to credit where appropriate (promotion, inspiration or reference), and not falsely claim.

Avoid prohibiting inspiration or reference; similarity is not proof of plagiarism!
→ It is possible for creators to have a similar idea, share the same reference, or take respectful inspiration!
→ It should be expected that work(s) clearly and directly referenced or inspired by your creation is fairly credited.

Avoid restrictive use policies that are difficult to monitor and enforce.
→ It is an unfortunate reality that players +/- servers will violate agreements, especially if they are restrictive.
→ There is limited legal recourse to address this; so state what you are willing and able to action if necessary!

Consider providing content in a compact format with minimal individual downloads!
→ Players and servers will be less likely to distribute (or more likely to use) easily accessible files.
→ It is suggested to provide creator pack(s) in bundles such as 'Bays', 'Pintos', '2023 Coats'

Avoid uploading to unsecure file hosting sites or encouraging users to engage in unsafe internet habits.
→ It is recommended to use popular sites such as Kofi, Google Drive.

EXAMPLE TERMS OF USE (NOT A LEGAL CONTRACT OR LICENSE)

• OWNERSHIP & AGREEMENT
  → The creator (name) retains all rights of ownership to this content
  → The right to use this content is granted to you (player) in accordance with this agreement
  
• USE
  → This creation can/not be used in content (images, videos) - credits are optional but appreciated.
  → This creation can/not be used privately in singleplayer or a small private group.
  → This creation can/not be used publicly in multiplayer.
  → This creation can/not be used in reasonable commercial services with/without consent.
      ✅🚫 Offered as part of a service (ie random / selected coat change) requiring real money
      ✅🚫 Offered as a prize or reward for activity or events requiring real money
      ✅🚫 Offered as an unlock via crowdfunding or engagement (ie server cost covered -> unlock)
      NOTE: Commercial services must abide by Minecraft's EULA
  
  
• DISTRIBUTION
  → This creation can/not be reuploaded with/without consent and/or credits and/or payment.
      ✅🚫 Limited private use by friends or small groups
      ✅🚫 Custom Community Packs (folder) 
      ✅🚫 Custom Modpacks (zip)
      ✅🚫 Exceptions: Paid vs Free, Commissions (paid) or Gifts (prizes)
      ✅🚫 Other: File Hosting Sites, Discord Servers etc
  
• ALTERATIONS
  → This creation can/not be altered with/without consent and with/without credits for public/private use.
      ✅🚫 Texture
      ✅🚫 Information (json: name, description, color tags etc)
      ✅🚫 Other conditions 

⮞ LEGACY MODEL
Legacy model is the current horse model in game, but more models are planned in future.

• Texture must use the legacy model texture path
• Future model types may come pre-listed listed, but do not function in game
  

⮞ TEXTURE PATH
Texture path is the location of the coat file placed in artist_packname > jsons > coats > legacy > artist_coatname.png

• Texture path must match the exact name of the coat png file
  → Must be a lowercase name with no spaces or symbols
  → Can include numbers or underscores 
  → Should use the format artist_coatname or artist_coatname_legacy to indicate it uses original model
  → Should share the same or similar name as the json file

⮞ COAT CYCLING
Coat cycling is the function that allows a player to cycle through coat options by right clicking a horse with redstone or lapis.

• Cycling a coat will only work if:
  → Set to "lapis_cyclable": true, in the json file
  → Coat cycling is enabled in server config allowCoatCycling = true 
  → Coat is not blacklisted in server config blacklistedCoatIds
  → Server config is per-world; enabling settings in one world does not auto-apply it to others!
  
  
• Summoning a (random) coat via command will only work if:
  → Set to "lapis_cyclable": true, in the json file
  → Coat is not blacklisted in server config blacklistedCoatIds

⮞ BREEDING & COLOR TAGS

• Color tags must use at least one of 7 valid choices:
  → ["black","gray","white","creamy","brown","dark_brown","chestnut"]
  → Separate multiple tags with a comma
  → There must not be a comma between " and ]
  
  
• Coats can appear from converting horses if:
  → Coat has at least one valid color tag
  → Coat has the same color tag as the vanilla horse (randomly chooses from coat options)
  → Set to "obtainable_by_breeding": true, in the json file
  → Converting is enabled in server config file (default) tokensBreeding = false
  → Coat is not blacklisted in server config blacklistedCoatIds
  → Server config is per-world; enabling settings in one world does not auto-apply it to others!
  
  
• Coats can appear from breeding if:
  → Set to "obtainable_by_breeding": true, in the json file
  → Coat is not blacklisted in server config blacklistedCoatIds
  → Foals are assigned one tag from any their parents have and use one of 7 foal coats (one per tag)
  → Foals choose from a random adult coat with the same tag when they grow up
• Color tags and breeding outcomes are very basic and do not support realistic genetics
  → Setting tags you expect the horse to 'pass on' is more likely to get your coat from those tags.
  → Example: Bay coat with "chestnut", "black", "brown" - any chestnut, black or brown foal can grow up to use it.
  → Setting tags for any color a coat has a small amount of will result in dramatic changes from foal to adult coats.
  → Example: Leopard Appaloosa with "black", "white" - a fully black foal would grow up to a mostly white coat.

 RECOMMENDATION
→ Set one or two tag(s) for a foal color you would expect to get the coat from Example: Black Foal -> Black Horse 

COMMUNITY PACK TROUBLESHOOTING
Follow each step slowly and carefully before you request help. Note down any issues that apply as you go.

⮞ [1] MOD VERSION

• Double check you are using the latest 1.20.1 Beta version.
  → Even if you feel sure, go and check it. It's the most common error!
  → Curseforge App Will not auto-install beta files, go to mod's page > versions > install
  → Multiplayer Servers Check server is on latest release
  → Multiplayer Users Check client + server use same version
  ⚠️ Community Packs are for 1.20.1-1.5 and above only.
  

⮞ [2] OFFICIAL COMMUNITY PACK VERSION

• Skip this step if you are not using the official Community Pack.
  → Check you have swem_community_pack_beta_5 or above.
  → Check this is the latest version posted - it may have a new release!
  → Multiplayer Servers Check server has the correct pack
  → Multiplayer Users Check clients have the same pack name + contents as server
  

⮞ [3] COMMUNITY PACK LOADING

• Open the game and load into a world
• Type /swem summon LEGACY
  → Is the pack listed? 
  → Is any pack listed (excluding swem:)
  
  ✅ Pack(s) are recognized
  ❌ Pack(s) are not recognized, specific packs are invalid or have no valid files. Go to solutions [3].

⮞ [4] COAT REGISTERED

• Type /swem summon LEGACY packname:
  → Is the coat(s) you expect to see listed? Example kofi_coats:spirit_arishant_legacy
  
  ✅ Coat(s) have registered.
  ❌ Coats have not registered OR specific coat(s) are invalid. Go to solutions [4].

⮞ [5] JSON -> TEXTURE PATH

• Summon coat(s) from the pack
  → Do coat(s) have a texture that is correct for that horse?
  
  ✅ Coat(s) have the correct texture
  ❌ Black Texture Texture path or file name is invalid or missing. Go to solutions [5].
  ❌ Wrong Coat Texture path or file name is incorrect. Go to solutions [4].
  ❌ Looks Wrong Texture or UV map error. Contact Coat Artist or request help.
  

⮞ **[6] OTHER**
> `Lapis Cycling` If you cannot cycle **any** coats, disabled in `serverconfig`. If the coat doesn't show, it is disabled in the coat `json`.
> `White Texture` If a coat is white, the pack or specific files were removed **OR** the information was changed (or wrongly edited). See [5] below.
> `Texture Issue` If a coat is broken (color in wrong places, missing pixels, marker blocks) contact the coat artist.
> `Error On Load` Put your **latest.log** file in #︱§・tech-help (too many potential causes). 

# SOLUTIONS & SUGGESTIONS
```ALWAYS SHUT DOWN THE GAME + RELOAD AFTER MAKING CHANGES```
⮞ **ISSUE [3]** Check the community pack...
> - Valid **lowercase + no spaces** name. Example: :white_check_mark: `kofi_coats` :regional_indicator_x: `KoFi Coats`
> - Placed in `config > swem > community-packs > pack_name`
> - Placed as a **folder** and not a zip file!
> - Includes **at least** one `json` file and one `png` texture in the correct location:
>    ⮞ `📁 jsons > 📁 coats > JSON FILES HERE`
>    ⮞ `📁 textures > 📁 coats > 📁 legacy > PNG FILES HERE`
> :information_source: If all of this is correct, you will need to check the files themselves are correct. Go back to step [4] above.

⮞ **ISSUE [4]** Find the JSON file for an unlisted coat and check...
> - Valid **lowercase + no spaces** name. Example: :white_check_mark: `hidalgo_arishant_legacy` :regional_indicator_x: `HIDALGO Arishant`
> - Placed in `📁 pack_name > 📁 jsons > 📁 coats > JSON FILES HERE`
> :information_source: If all of this is correct, upload your **json file** in TECH HELP.

⮞ **ISSUE [5]** Choose a coat (black texture) and check...
> - `png` has a valid **lowercase + no spaces** name.
> - `png` placed in `📁 textures > 📁 coats > 📁 legacy > PNG FILES HERE`
> - `json` is actually a JSON file
> - `json` correctly states texture path inside quotations `""`, with no typos
>     ⮞  :white_check_mark: `"default:legacy/hidalgo_arishant_legacy"`
>     ⮞  :regional_indicator_x: `"default:coats/legacy/hidalgo_arishant_legacy"` Outdated format
>     ⮞  :regional_indicator_x: `"default:coats/legacy/hidlago_arishant_legacy"` Typo 
>  - `json` correctly states colour tags with **no spaces**
>      ⮞  :white_check_mark: `["black","white"]`
>      ⮞  :regional_indicator_x: `["black", "white"]`

⮞ **[6] OTHER -OR- NOTHING WORKED**
```POST IN TECH HELP, INCLUDE ANY NOTES ON YOUR ISSUE(S) AND WHAT YOU HAVE TRIED! DO NOT UPLOAD PAID/PRIVATE PACKS OR FILES```

Tokens are a form of currency to exchange for tack pieces. This is so every item does not need a crafting recipe.

• Tokens are redeemed at an EQ Shop block - this displays all purchases possible for the given token.
• You must set a crafting recipe to create tokens at a crafting table.
• You can set a yield of 1-64 tokens per crafting.
• You must create at least one Token Example Creatorname Coin
• You can name them whatever you want; tokens coins, credits etc.
• You can create multiple themed or tiered tokens Example Basic Token Valuable Token
• You can set custom pricing for your items in their individual .json files Example Saddles cost 5 Creator Coins
  

RECOMMENDATIONS
→ Keep tokens to a minimum; each one is a new item added to the game.
→ Set a unique name that is unlikely to be duplicated (confusing to players) such as Yourname Token or Packname Coin
→ Set a recipe that is unlikely to be duplicated with Minecraft recipes or tokens for other creators.
→ Use Content Packs or individual files to 'add-on' to a core pack, rather than creating many individual packs + tokens.

WARNING TO CREATORS (+ SURVIVAL SP / SERVERS THAT USE COMMUNITY PACKS)
→ Removing or renaming tokens will void any currently in game - players that crafted them will lose them!
→ This is why is is recommended to think carefully about what tokens you add and support them long term.

{
  "name": "Example Coin",
  "tokens": {
    "token_1": {
      "texture": "tokens/example_coin.png",
      "recipe": {
        "count": 4,
        "pattern": [
          " R ",
          "ODO",
          " G "
        ],
        "key": {
          "R": {
            "item": "minecraft:redstone"
          },
          "O": {
            "item": "minecraft:obsidian"
          },
          "D": {
            "item": "minecraft:diamond"
          },
          "G": {
            "item": "minecraft:gold_ingot"
          }
        }
      }
    }

pattern refers to the 9 slots in a crafting grid, with each slot being a potential space to place one item.

"pattern": [
          " R ",
          "ODO",
          " G "

Shown above is an example where 5 items are placed in a crafting grid; one slot in top row, three in middle and one bottom row.
Each occupied slot has a letter or symbol that is later defined under key - this says which item that will be.

• The letters you choose do not matter, but they can only specify ONE type of item.
• If a slot is unused, it is recommended to use a space (no letter or symbol)
  → Example: Empty row ✅ " " 
  

"key": {
          "R": {
            "item": "minecraft:redstone"
          },
          "O": {
            "item": "minecraft:obsidian"
          },
          "D": {
            "item": "minecraft:diamond"
          },
          "G": {
            "item": "minecraft:gold_ingot"
          }
        }

Shown above is the  key section which defines those letters; R for redstone, O for obsidian, D for diamond, G for gold ingot.

• Note that each item comes in it's own little code section which is correctly indented (positioned)
• Each letter is defined as ONE specific item, and that item includes the ID minecraft:item_name 
• This would allow you to specify IDs of other mods such as swem:item_name
  → The recipe will not work if it specifies an item the player does not have the mod for, or cannot obtain.
  

Shown: Overlay of json information vs in-game crafting.

"pattern": [
          " / ",
          "# #",
          " / "
        ],
        "key": {
          "/": {
            "item": "minecraft:blaze_rod"
          },
          "#": {
            "item": "minecraft:gold_ingot"
          }
        }

Shown above is another example with four items in the crafting grid; top row middle, middle row left + right, bottom row middle.
This example uses symbols instead of letters, which are less clear but work fine.
The key section states two items, / for blaze rod and # for gold ingot.

  HELPFUL RESOURCES  

JSON files require correct formatting, including indentation (position on the page). If this is confusing, try:

• Editing the example template file provided [DISCORD LINK] 
• Using a recipe generator for datapacks HERE 
  → Search for and drag your items into the crafting grid
  → Scroll down and copy the relevant sections (pattern and key)
  → Recommendation: Copy from "pattern" to the last " for crafting items, such as "minecraft:gold_ingot" 
  → Open your tokens file, select the same points ("pattern" to ") and paste