r2mods/README.md

57 lines
2.1 KiB
Markdown
Raw Normal View History

2024-10-04 07:26:18 +00:00
# R2mods
Knowledge dumping on ror2 modding community - how I can improve everything, as well as
keeping all of the code (or disassembled) dump in one place - tracking with a modpack
that me and my frenns are playing, duped `choncc`
## Merging codebase across multiple sources
This is the ultimate test for Git knowledge, you can't just go and submodule everything.
I'll maintain this along with `choncc` and dump as many versions of the mods being tracked
## Disassemblies
Use this IN CONJUNCTION WITH original code if available. This is mostly because code quality
from conventional codebase is no simpler than the disassembled code (surprisingly?).
Will go onto [ilspy_dump](./ilspy_dump), before we figure out how to use `ilspycmd`, we'll
just use the GUI.
For now, no naming convention yet, I'll try to export both a singular C# file AND the whole C# project
- `ror2.dll` is in `//SteamLibrary/steamapps/common/Risk\ of\ Rain\ 2/Risk\ of\ Rain\ 2_Data/Managed/ror2.dll`
## R2 profile footprint
Per the code (TODO: ADD SOURCEGRAPH QUERY AND CODE HERE), it only contain mod manifests and configurations,
very little non-configuration files are in here because file extensions are hard-coded for filter during
profile sharing process.
**Locations of mod profiles**
- [r2modman](https://github.com/ebkr/r2modmanPlus/tags) is in `%AppData%/r2modmanPlus-local/RiskOfRain2/profiles`
- [thunderstore (WARNING: DOWNLOAD ON CLICK)](https://www.overwolf.com/app/Thunderstore-Thunderstore_Mod_Manager) is in `%AppData%/Thunderstore\ Mod\ Manager/DataFolder/RiskOfRain2/profiles`
**Doxxing yourself**
I've provided [script to check for dox](./scripts/doxless.py), turns out
r2modman:
- Uses abspath, of Windows machines, on `%AppData%` (default: `SysDrive:/User/<USERNAME>/AppData/Roaming`)
for icon paths
2024-10-05 03:42:01 +00:00
- Does not erase this information on export
This is one way to leak information. I did not remove it in the current sync.
The r2modman's importer can just check for validity and go grab a different path.
Note that you'll probably will have a much better performance via `rg $USER`,
this script currently doesn't offer much.
```sh
python3 scripts/doxless.py
"""
*.mods.yml
"""
```