Giter Site home page Giter Site logo

sbox-custodia's Introduction

UPDATE: 5 June 2022

Custodia is nowhere near complete (and hasn't been contributed to since last September).

However, I, piqey (aka John Connor), do plan to return to this project, though the timing of this is uncertain. This could be today, tomorrow, or months from now, but I feel as though it will be one of the former, i.e., very soon. This would be the first milestone in my return to programming in s&box, something that has recently and spontaneously regained my interest for no discernable reason.

Until then, I am archiving this repository for the sake of cleanliness (and my own sanity by consequence).

I'm working on this again. We'll see where it goes.

custodia

Custodia aims to be a robust and modular add-in administration framework for any of your s&box projects whilst maintaining a relatively lightweight form factor that attempts to avoid giving any s&devs unnecessary conniptions. It comes prepackaged, ready for use and structured with the streamlining of new updates in mind. I also intend to organize Custodia in a manner such that any repositories configured to automatically pull submodule updates will be able to do so without any complications.

Installation

To include this in your project, create a git submodule in your repository. The command you issue in your git repository's root folder should look something like this: git submodule add https://github.com/piqey/sbox-custodia/code/Custodia/ (your capitalization of the letter "C" in "code" may vary). After taking care of adding the submodule, it can later be updated via the use of the git submodule update command.

Once you've taken care of that, the only required modification to make use of Custodia's features is that you derive your Game subclass from Custodia.Game (and ensure that you are calling its base methods in your overrides).

Guide

If you've managed to progress far enough in s&box's API to have a use for this, you don't need me to tell you how it works (or how you can add features to it without touching the submodule files).

Additional Notes

If you make a fork of this repository just to add features, I will be thoroughly disappointed. The entire objective in designing Custodia was and always will be to achieve legitimate modularity without the need for modifying Custodia itself; the vast majority of features one may be seeking to add to Custodia are likely achievable through one's own files in one's own repository (and a pinch of intuition).

sbox-custodia's People

Contributors

piqey avatar salamunder avatar thomasterp avatar

Stargazers

 avatar

Watchers

 avatar  avatar

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.