https://github.com/reactive-graph/asset-repository-example

Inexor - Asset Repository - Example
https://github.com/reactive-graph/asset-repository-example

asset repository

Last synced: 11 days ago
JSON representation

Inexor - Asset Repository - Example

• Host: GitHub
• URL: https://github.com/reactive-graph/asset-repository-example
• Owner: reactive-graph
• License: mit
• Created: 2022-01-15T12:23:00.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2022-01-17T17:16:09.000Z (almost 3 years ago)
• Last Synced: 2024-04-06T17:28:40.840Z (8 months ago)
• Topics: asset, repository
• Homepage:
• Size: 14.1 MB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Example asset repository

## What is an asset repository?

Game modes and maps uses assets like textures, skyboxes, sound effects and so on. An asset repository provides

these assets in asset collections.

## Which asset types exists?

1. crosshairs

2. fonts

3. icons

4. images

5. maps

6. models

7. skyboxes

8. sound effects

9. sound tracks

10. textures

## Why asset repositories?

Inexor can handle multiple repositories from different sources. Everyone can create its own repository. An

asset repository is basically a public git repository which follows a certain structure.

## What is the structure of an asset repository? 

This example repository provides a full example how an asset repository is structured.

The folder structure is as following:


  /collections

    /name_of_the_collection

      /assets

        /crosshairs

          /name_of_the_crosshair

            crosshair.toml

        /fonts

          /name_of_the_font

            font.toml

        /images

          /name_of_the_image

            image.toml

        /icons

          /name_of_the_icon

            icon.toml

        /maps

          /name_of_the_map

            map.toml

        /models

          /name_of_the_model

            model.toml

        /skyboxes

          /name_of_the_skybox

            skybox.toml

        /sound_effects

          /name_of_the_sound_effect

            sound_effect.toml

        /sound_tracks

          /name_of_the_sound_track

            sound_track.toml

        /textures

          /name_of_the_texture

            texture.toml



## What is the advantage of this structure?

 

* An asset repository can provide multiple asset collections

* An asset repository can provide multiple assets of each asset type

* A single asset can consist of multiple files (for example textures or skyboxes)

* Meta-information about the asset must be provided

  * You can provide license information about your asset (license identifier and license attribution text)

  * You can provide versioning information about your asset (semantic versioning)

* Extendable for future asset types