Skip to content

Psych Engine modpack utilities and premade assets.

License

Notifications You must be signed in to change notification settings

galactic2005/PEModUtils

Repository files navigation

PEModUtils

Banner

PEModUtils is a repository containing various premade assets available to use for Psych Engine or any engines built off it.

  • Lua Stage Recreations - stage recreations made in Lua.
  • Utilities - utilities made for a variety of use cases.

This allows you to focus on what's needed in your project with not having to deal with manually creating backend code or debugging code.

Setup/Usage

Cloning

Use git to clone.

git clone https://github.com/galactic2005/PEModUtils.git

Lua Stage Recreations

Place the associated .json and .lua file into the stages/ folder of a mod.

Utilities

To use an utility, use require().

local file = require(currentModDirectory .. '/file')

-- returns the current version of file
debugPrint(file._VERSION)

Refer to the Documentation/ folder or the PEModUtils Wiki for information on modules and how to use them.

Help

If you need help with how to use something in this repository or if there's a problem with code, please open an issue.

Altnatively, you can contact me through Discord at galactic_2005. I'll be sure to provide assistance to the best of my ability.

Contributing

This repository is open to contributions. See CONTRIBUTING for details.

If you'd like to see who contributed, see CONTRIBUTORS

License

This utility is free software; you can redistribute it and/or modify it under the terms of the MIT license. See LICENSE for details.