Chili:Adding To Game: Difference between revisions

From Spring
Jump to navigationJump to search
m add brief section on how chili works
 
(14 intermediate revisions by 3 users not shown)
Line 1: Line 1:
[[Main_Page|Wiki]] < [[Chili|Chili]] < Adding Chili To A Game
== Getting Chili ==
== Getting Chili ==


The Chili repository can be found at [https://github.com/jk3064/chiliui https://github.com/jk3064/chiliui]. There are two ways to add Chili to your game:
The Chili repository can be found at <del>[https://github.com/jk3064/chiliui https://github.com/jk3064/chiliui]</del> [https://github.com/gajop/chiliui https://github.com/gajop/chiliui]. There are three ways to add Chili to your game:
 
* Include the Chili repository as a git submodule in your project.
* Include the Chili repository as a git submodule in your project.
* Checkout the Chili repository, and place the files from its /luaui/chili directory into your games /luaui/widgets directory.
* Include Chili as a dependency in [[Modinfo.lua|modinfo.lua]], using the line <code>depend={"Chili Framework v2014.0"}</code>.
* Checkout the Chili repository, and manually place the files & subdirs from its /luaui/chili directory into your games /luaui/widgets directory.
 
If you are having trouble getting Chili to run, login to the lobby and join the #moddev channel (type /j moddev).  People there will help you figure it out.
If you are having trouble getting Chili to run, login to the lobby and join the #moddev channel (type /j moddev).  People there will help you figure it out.


== Chili interaction with game internals ==
== Chili interaction with game internals ==


The Chili library is, basically, a very big widget. It is loaded as a widget by the widget handler, and it makes its functions accessible via WG. This allows `normal' widgets to use Chili - a widget may call a function from inside WG.Chili, which instructs the chili library to create/modify a particular GUI element.
The Chili library is, basically, a very big widget. It is loaded as a widget by the widget handler, and it makes its functions accessible via WG. This allows 'normal' widgets to use Chili - a widget may call a function from inside WG.Chili, which instructs the chili library to create/modify a particular GUI element.
 
[[Category:Libraries]]

Latest revision as of 11:25, 7 June 2020

Wiki < Chili < Adding Chili To A Game

Getting Chili

The Chili repository can be found at https://github.com/jk3064/chiliui https://github.com/gajop/chiliui. There are three ways to add Chili to your game:

  • Include the Chili repository as a git submodule in your project.
  • Include Chili as a dependency in modinfo.lua, using the line depend={"Chili Framework v2014.0"}.
  • Checkout the Chili repository, and manually place the files & subdirs from its /luaui/chili directory into your games /luaui/widgets directory.

If you are having trouble getting Chili to run, login to the lobby and join the #moddev channel (type /j moddev). People there will help you figure it out.

Chili interaction with game internals

The Chili library is, basically, a very big widget. It is loaded as a widget by the widget handler, and it makes its functions accessible via WG. This allows 'normal' widgets to use Chili - a widget may call a function from inside WG.Chili, which instructs the chili library to create/modify a particular GUI element.