Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
116 lines (89 loc) · 3.88 KB

CONTRIBUTING.md

File metadata and controls

116 lines (89 loc) · 3.88 KB

Contributing to ForgeMapToolkit Assets

Thank you for your interest in contributing! This document explains how to submit assets and report issues.

What You Can Contribute

  • Skybox presets — new .scmskybox files with preview images
  • Unit preview images — PNG thumbnails for FA factions or Nomads
  • Prop preview images — PNG thumbnails for environment props
  • Bug reports — broken previews, wrong folder structure, loading errors

Submitting a Skybox

Folder Structure

skyboxes/
  <Category>/           # e.g. Earth, Desert, Space, Custom
    <SkyboxName>/
      <SkyboxName>.scmskybox
      prev/
        1.png           # Required — shown as card thumbnail
        2.png           # Optional
        3.png           # Optional
      assets/           # Custom skyboxes only
        <name>.dds
        <name>_glow.dds

Requirements

  • The .scmskybox file must be valid JSON
  • The copyright block must be present at the top of the file (see below)
  • Preview images must be in prev/, named 1.png, 2.png, 3.png
  • Preview images should be 1920×1080 or 1280×720, PNG format
  • Skybox name should be descriptive — Arctic_Twilight not test1
  • All file and folder names must be lowercase (enforced by pre-commit hook on v2-dev)

Copyright Block

Every .scmskybox file must include this block at the top:

"_copyright": [
    "============================================================",
    " ForgeMapToolkit Assets — Skybox Preset",
    " Copyright (c) 2026 Seraphim-Noob",
    "============================================================",
    "",
    " LICENSE: Creative Commons Attribution-NonCommercial 4.0",
    "          International (CC BY-NC 4.0)",
    "",
    " You are free to:",
    "   - Share  — copy and redistribute this file in any medium",
    "   - Adapt  — remix, transform, and build upon this material",
    "",
    " Under the following terms:",
    "   - NonCommercial — You may not use this material for",
    "                     commercial purposes.",
    "   - No additional restrictions — You may not apply legal",
    "                     terms or technological measures that",
    "                     legally restrict others from doing",
    "                     anything the license permits.",
    "",
    " This copyright block must remain intact in all copies",
    " and derivative works.",
    "",
    " Full license: https://creativecommons.org/licenses/by-nc/4.0/",
    " Repository:   https://github.com/SeraphimNoob01/ForgeMapToolkit-Assets",
    "============================================================"
],

Submitting Unit or Prop Previews

  • Unit previews go in units/<UnitID>.png
  • Prop previews go in props/<PropName>_albedo.png
  • Recommended size: 256×256 or 512×512, PNG format
  • Nomads unit blueprints go in nomads/<UnitID>/<UnitID>_unit.bp

Pull Request Checklist

  • Files are in the correct folder with the correct structure
  • .scmskybox files contain the copyright block
  • Preview images are included in prev/ (skyboxes)
  • Image dimensions follow the guidelines above
  • No copyrighted third-party assets included without permission
  • PR title clearly describes what is being added
  • Tested that the asset loads correctly in ForgeMapToolkit

Reporting Issues

Use the Bug Report template for:

  • Missing or broken preview images
  • Assets not loading in ForgeMapToolkit
  • Incorrect folder structure or malformed files

Use the Asset Request template to suggest new skyboxes, unit previews, or prop previews.

Please only report issues related to this Assets repository. For bugs in the toolkit itself, open an issue on the ForgeMapToolkit repository.

Code of Conduct

Please read CODE_OF_CONDUCT.md before participating.