Skip to content

Commit

Permalink
Showing 1 changed file with 0 additions and 56 deletions.
56 changes: 0 additions & 56 deletions README.md
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`.

0 comments on commit f342505

Please sign in to comment.