Coder Social home page Coder Social logo

ultreon / ultreon-data Goto Github PK

View Code? Open in Web Editor NEW
3.0 1.0 1.0 566 KB

NBT inspired data I/O. Made for games.

Home Page: http://ultreon.github.io/ultreon-data/docs/latest

Java 100.00%
api binary-data data data-storage file-type io library game-data ubo

ultreon-data's Introduction

Ultreon Binary Object

File Extension: .ubo
API Language: Java 8

Usage

Assuming you use gradle.

  1. In build.gradle, define the repository as follows:
    repositories {
        // ...
        maven { url "https://github.com/Ultreon/ultreon-data/raw/main/.mvnrepo/" }
    }
  2. Then, in build.gradle, define the dependency:
    dependencies {
        implementation 'io.github.ultreon:ubo:1.2.1+patch.1'
    }
  3. We can now proceed to the using section. The DataIo class is capable of reading and writing UBO data.
    Example:
    import com.ultreon.data.DataIo;
    import com.ultreon.data.types.MapType;
    import java.io.File;
    
    public class DataTest {
        public static void main(String[] args) {
            MapType type = new MapType();
            type.putString("greetings", "Hello World");
            
            DataIo.write(type, new File("data.ubo"));
        }
    }
  4. You can now build it. You can change the example in step 3 to suit your needs.

Here's the jitpack listing for the current versions and builds you can use. (Temporarily not used)
Check out the releases page for latest releases.

Naming conventions

The following conventions are for map keys:

  • MapType and ListType are in PascalCase.
  • Any other types are in camelCase.

Do note that in some cases keys can have a different case.
For example if the key is used for identifiers. (Like those: namespace:id)
Tho it's generally not recommended to use map keys for objects like identifiers or numbers.

ultreon-data's People

Stargazers

 avatar  avatar  avatar

Watchers

 avatar

Forkers

andeditor7

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.