https://github.com/alandtse/skyrim_vr_address_library

Address library for converting Skyrim SSE skse mods to Skyrim VR

https://github.com/alandtse/skyrim_vr_address_library

Science Score: 26.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
  • Academic publication links
  • Academic email domains
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (9.5%) to scientific vocabulary

Keywords

reverse-engineering skyrim-modding skyrim-vr
Last synced: 5 months ago · JSON representation

Repository

Address library for converting Skyrim SSE skse mods to Skyrim VR

Basic Info
  • Host: GitHub
  • Owner: alandtse
  • License: mit
  • Language: Python
  • Default Branch: main
  • Homepage:
  • Size: 54.2 MB
Statistics
  • Stars: 18
  • Watchers: 2
  • Forks: 24
  • Open Issues: 0
  • Releases: 202
Topics
reverse-engineering skyrim-modding skyrim-vr
Created over 4 years ago · Last pushed 6 months ago
Metadata Files
Readme Changelog Contributing License

README.md

Skyrim VR Address Library

GitHub Release GitHub all releases GitHub release (latest by SemVer) GitHub Activity

License

Project Maintenance BuyMeCoffee

Tools for converting a Skyrim SSE skse mod to VR.

Description

This repo includes CSV files that include various data. This is meant to be processed by https://github.com/alandtse/vraddresstools.

CSV Files

database.csv

A csv for generating release csv files for loading in CommonLibVR to replace addresslib. This intended to be a database to identify addresslib ids that represent SkyrimSSE addresses and convert to appropriate VR address. This can be manually edited and is intended to be a community resource. The database.csv can be converted to a release csv using vraddresstools.py generate.

|id|sse|vr|status|name| |---|--|--|--|----| |10878|0x1400f7210|0x1401077c0|3|RE::Offset::BGSDefaultObjectManager::GetSingleton

  • id - Addresslib id
  • sse - SSE Address with base (e.g., 0x1400f7210)
  • vr - VR Address with base (e.g., 0x1401077c0)
  • status - The level of confidence in the VR address.
    • 0 - Unknown
    • 1 - Suggested by automatic tools
    • 2 - Manually entered and assumed manually verified
    • 3 - Manually entered with suggested automatic tools verification
    • 4 - Bit for bit identical (offsets and patches should work identically)
  • name (optional) - A friendly name to describe the id

Release CSVs

A non-standard csv installed by end users in the data/skse/plugins/ directory. This follows the addresslib naming of version-{skyrim version}.csv. The first row of data is the csv header, second row is meta data, and third row and beyond is the actual data:

| id | offset | |-----|--------| | total entries | version | | 10878 | 01077c0 | * id - Addresslib id * offset - VR Address as offset (e.g., 01077c0) * total entries - The number of entries to reserve space for. WARNING: CTDs may occur if the total entries is less than the actual number of entries since it is allocating space for a memory map. * version - The release version which is a semantic version.

Analysis CSVs

These are CSVs intended to aid in analysis.

offsets-1.5.97.0.csv

A dump of addresslib for SkyrimSSE 1.5.97.0. This should be considered canonical for the id -> sse mapping.

|id|sse| |--|--| 2|10d0

  • id - Addresslib id
  • sse - SSE offset (e.g., 10d0)
addrlib.csv

A mapping file generated by bakou using ida. Partially automated. |vr|sse|id| |--|--|--| 0x1400010d0|0x1400010d0|2 * vr - VR Address with base (e.g., 0x1401077c0) * sse - SSE Address with base (e.g., 0x1400f7210) * id - Addresslib id

sse_vr.csv

A mapping file generated by meh321 using IDADiffCalculator, the script used to calculate SSE offsets. Partially automated. |sse|vr| |--|--| |0x141992C10|0x141A33D38| * sse - SSE Address with base (e.g., 0x1400f7210) * vr - VR Address with base (e.g., 0x1401077c0)

offsets-1.6.318.0.csv

A dump of addresslib for SkyrimSSE 1.6.318.0 (AE). This should be considered canonical for the aeid -> ae_addr mapping.

|aeid|ae_addr| |--|--| 1|140001022

  • aeid - Addresslib id for Anniversary Edition
  • ae_addr - AE offset (e.g., 140001022)
1.5.97_comments.csv

Some mappings by Ultra of 1.5.97.0 used in IDA/ghidra. This has some naming info (but should be considered less current then AddressLibraryDatabase)

|sseaddr|comments| |--|--| 140001258|anonymousnamespace_MonitorAPO::Func9140001258

  • sse_addr - SSE offset (e.g., 140001022)
  • comments - Potential name (e.g., anonymousnamespaceMonitorAPO::Func9140001258)
se-ae-attempted-match.csv

Algorithmic mapping of SSE to AE addresses. This is a csv version of what is available under misc files at address library.

|sseaddr|aeaddr| |--|--| 140001022|140001022

  • sse_addr - SSE offset (e.g., 140001022)
  • ae_addr - AE offset (e.g., 140001022)
se-ae_offsets.csv

Output of [merge.py]. This tries to map various comments with the offsets* file. This is an algorithmic only mapping and meant as input for vr_address_tools.

|sseid|sseaddr|aeaddr|aeid|comments |--|--|--|--|--| 5|140001258|140001258|11.0|MonitorAPO::Func9_*

  • sseid - SSE ID
  • sse_addr - SSE offset (e.g., 140001022)
  • ae_addr - AE offset (e.g., 140001022)
  • aeid - AE ID
  • comments - Name
se-ae.csv

Output of [vraddresstools.py]. This takes the automated items from seaeoffsets and combines it with se-ae.csv and whatever is scanned by vraddresstools.

|sseid|aeid|confidence|name |--|--|--|--| 5|11|1|MonitorAPO::Func9_*

  • sseid - SSE ID
  • aeid - AE ID
  • confidence - The level of confidence in the mapping.
    • 0 - Unknown
    • 1 - Suggested by automatic tools
    • 2 - Manually entered and assumed manually verified
    • 3 - Manually entered with suggested automatic tools verification
    • 4 - Bit for bit identical (offsets and patches should work identically)
  • name - Name ## Address IDs

Address IDs are keyed into SSE. However, occasionally an SSE address will not have an Address ID. In that case, they may still be entered by taking the integer value of the SkyrimSSE address.

|id|sse|vr|status|name| |---|--|--|--|----| |5370397616|0x14019c3b0|0x1401ac0e0|3|RE::BSShaderProperty::InvalidateMaterial

Contributions are welcome!

If you want to contribute to this please read the Contribution guidelines


Owner

  • Name: Alan Tse
  • Login: alandtse
  • Kind: user

GitHub Events

Total
  • Release event: 30
  • Watch event: 4
  • Issue comment event: 36
  • Push event: 64
  • Pull request review event: 3
  • Pull request event: 46
  • Fork event: 9
  • Create event: 31
Last Year
  • Release event: 30
  • Watch event: 4
  • Issue comment event: 36
  • Push event: 64
  • Pull request review event: 3
  • Pull request event: 46
  • Fork event: 9
  • Create event: 31

Issues and Pull Requests

Last synced: 5 months ago

All Time
  • Total issues: 9
  • Total pull requests: 102
  • Average time to close issues: 9 months
  • Average time to close pull requests: about 17 hours
  • Total issue authors: 3
  • Total pull request authors: 16
  • Average comments per issue: 0.22
  • Average comments per pull request: 0.85
  • Merged pull requests: 91
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 0
  • Pull requests: 39
  • Average time to close issues: N/A
  • Average time to close pull requests: about 19 hours
  • Issue authors: 0
  • Pull request authors: 9
  • Average comments per issue: 0
  • Average comments per pull request: 0.54
  • Merged pull requests: 31
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • alandtse (7)
  • RafearTheModder (1)
  • naqaden (1)
Pull Request Authors
  • Nightfallstorm (29)
  • FlayaN (20)
  • sicsix (11)
  • RafearTheModder (10)
  • SkyHorizon3 (8)
  • andperks6 (6)
  • NoahBoddie (3)
  • SaneEngineer (3)
  • W-Drew (2)
  • shuc1 (2)
  • mysticfall (2)
  • Shizof (2)
  • ChrisNonyminus (1)
  • jpstewart (1)
  • Seally (1)
Top Labels
Issue Labels
bug (1)
Pull Request Labels
released (39)

Dependencies

.github/workflows/semantic_release.yml actions
  • actions/cache v2 composite
  • actions/checkout v3 composite
  • actions/setup-dotnet v3 composite
  • cycjimmy/semantic-release-action v3 composite
  • edgarrc/action-7z v1 composite
  • snok/install-poetry v1 composite
  • svenstaro/upload-release-action v2 composite
.github/workflows/unex-check.yml actions
  • actions/setup-dotnet v2 composite
.github/workflows/update_submodule.yml actions
  • actions/checkout v2 composite