No description, website, or topics provided.
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
app
controller
lib
model
view
README.md
config.lua
functions.lua
game.lua
gui.lua
hook.lua
lang.lua
main.lua
user.lua

README.md

Gajos Framework

Script framework for CS2D to make your life easier

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Prerequisites

  • CS2D
  • Lua scripts

/sys/lua/server.lua

local mod_name = 'gajosframework'

-- init --
dofile('sys/lua/' .. mod_name .. '/main.lua')

Your framework copy goes here:

/sys/lua/<mod_name>/

Installing

A step by step series of examples that tell you have to get a development env running

Say what the step will be

Give the example

And repeat

until finished

End with an example of getting some data out of the system or using it for a little demo

Running the tests

Explain how to run the automated tests for this system

Break down into end to end tests

Explain what these tests test and why

Give an example

And coding style tests

Explain what these tests test and why

Give an example

Deployment

Add additional notes about how to deploy this on a live system

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Authors

  • Adrian Gajos - Initial work - Gaiyos

See also the list of contributors who participated in this project.

License

This project is licensed under the MIT License - see the LICENSE.md file for details

Acknowledgments

  • EnderCrypt