satisfactorymodding / satisfactorymodding/SatisfactoryModLoader
Consider adding/adapting TextAsset plugin to allow leaving notes in ExampleMod
Nobody has claimed this yet.
- Dominant language
- C++
- Stars
- 344
- Forks
- 225
- PR merge metrics
- No merged PRs in 30d
Description
Implement in SMLEditor
https://www.gmpreussner.com/reference/adding-new-asset-types-to-ue4
https://github.com/ue4plugins/TextAsset
➕ Would allow leaving notes in ExampleMod about why things are done without linking to the docs, visible right there in the editor right next to the files
➕ Mod devs could reuse this to add notes in their own files about ex. needed placeholders
➖ What would otherwise be plaintext stored in binary uassets
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start in SMLEditor and review the linked Unreal Engine asset-type reference and ue4plugins/TextAsset repository. Determine how a TextAsset-style plugin could support notes beside ExampleMod files and whether those notes should be stored in binary uassets. Done means the approach and its tradeoffs are resolved and the editor can provide the proposed note workflow.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- cpp, unreal-engine
- Domain
- tooling
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100