-
Notifications
You must be signed in to change notification settings - Fork 13
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- v1.14.2
- v1.14.1
- v1.14.1-rc.1
- v1.14.0
- v1.14.0-rc.2
- v1.14.0-rc
- v1.13.1-m1
- v1.13.0
- v1.13.0-m1
- v1.13.0-beta
- v1.12.9
- v1.12.9-m1
- v1.12.8
- v1.12.8-m1
- v1.12.7
- v1.12.7-m1
- v1.12.6
- v1.12.5
- v1.12.4
- v1.12.3
- v1.12.2
- v1.12.1
- v1.12.1-rc
- v1.12.0
- v1.11.2
- v1.11.1
- v1.11.1-rc1
- v1.11.0
- v1.10.0
- v1.10.0-rc1
- v1.9.6
- v1.9.5
- v1.9.4
- v1.9.3
- v1.9.2
- v1.9.2-rc
- v1.9.1
- v1.9.1-rc1
- v1.9.0
- v1.9.0-rc2
- v1.9.0-rc1
- v1.8.2
- v1.8.1
- v1.8.1-m1
- v1.8.0
- v1.7.1
- v1.7.0
- v1.6.1
- v1.6.0
- v1.6.0-m1
- v1.5.0
- v1.4.1
- v1.4.0
- v1.3.1
- v1.3.1-m3
- v1.3.1-m2
- v1.3.0
- v1.2.1
- v1.2.0
- v1.1.10
- v1.1.9
- v1.1.8
- v1.1.7
- v1.1.6
- v1.1.5
- v1.1.4
- v1.1.4-m1
- v1.1.4-m0
- v1.1.3
- v1.1.2
- v1.1.1
- v1.1.1-m1
- v1.1.0
- v1.1.0-rc1
- v1.1.0-m3
- v1.1.0-m2
- v1.1.0-m1
- v1.0.0
Showing
1 changed file
with
0 additions
and
56 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,57 +1 @@ | ||
# Codeware Lib | ||
|
||
## Features | ||
|
||
- _Global Registry_ | ||
* Store and retrieve objects by name | ||
- _Localization System_ | ||
* Translate the mod based on the game language settings | ||
* Use different language packages for the interface and subtitles | ||
* Vary translations based on player gender | ||
- _UI: Custom Widgets_ | ||
* Create composite widgets with logic | ||
- _UI: Buttons_ | ||
* Generic button template | ||
* Simple and Hub buttons | ||
- _UI: Popups_ | ||
* Generic popup template | ||
* In-game style popup (like Radio, Call Vehicle, Messenger) | ||
- _UI: Button Hints_ | ||
* Show action hints in your widgets | ||
- _UI: Text Input_ | ||
* Prompt for user input | ||
- _UI: Resolution Watcher_ | ||
* Apply scaling to widgets | ||
* Make adaptive layouts | ||
- _Hashing_ | ||
* TweakDBID | ||
* FNV1a64 (Experimental and ineffective) | ||
- _Delay System_ | ||
* Schedule events for UI controllers | ||
- _Native Extensions_ | ||
* Access native things that are not accessible by default | ||
|
||
## In Progress | ||
|
||
- _Text Input: Keyboard layouts_ – For typing in any language supported by the game | ||
- _Text Input: Multiline_ – Writing personal notes? | ||
- _Freeform Widgets_ – Drawing vector icons from scripts | ||
- _Scroll Pane / Scroll Bar_ – Large content and lists, virtual scrolling | ||
- _Menu Style Popup_ – Like in the Hub menu | ||
|
||
## Usage | ||
|
||
The lib can be used in two ways: as a shared or internal lib. | ||
|
||
### Shared | ||
|
||
You can add the lib as a dependency. | ||
|
||
:exclamation: Not published on Nexus yet. | ||
|
||
### Internal | ||
|
||
You can include a full or partial copy of the lib only with features you need in your mod. | ||
|
||
To prevent conflicts with other mods and / or shared lib, you must give your copy a unique namespace. | ||
For example, you can simply use your mod's namespace or prepend with it: `Codeware` → `MyMod.Codeware`. |