Skip to content
This repository has been archived by the owner on Jan 21, 2023. It is now read-only.

Latest commit

 

History

History
14 lines (11 loc) · 881 Bytes

README.md

File metadata and controls

14 lines (11 loc) · 881 Bytes

This is an example mod, demonstrating how to implement an item driver that allows placing items as components into computer cases and servers, and provide methods to the computer they are placed into.

To run it, after cloning the repository, set up your workspace with gradle as usual:

gradlew setupDecompWorkspace idea

I recommend enabling the Gradle plugin in IDEA. When opening the project in IDEA with it enabled, it will ask you whether you'd like to import the Gradle project. When you do so, it'll automatically set up the library dependency on the OC API for you.

The example item will allow spawning particle effects. When placed in a computer's card slot, it can be accessed as a component named "particle":

lua> for i = 1, 100 do component.particle.spawn("flame", 0, 2, 0) end

Feel free to submit pull requests to expand and/or clarify documentation!