infoThis version ships no README. Showing the README from v0.1.1, mirrored from wally.

Nekotool

Service bootstrapper for any realm!

Nekotool provides a bootstrapper for games that gives you asynchronous services that work together to provide a streamlined development experience!

Installation

Nekotool expects itself to be in ReplicatedStorage. You need to do some setup before you're able to fully utilise this library.

It expects there to be a Config module in a few places depending on where you're loading this from:

• If you're using this from a plugin, you just need to provide the Nekotool.config at your project root
• If you're using this in a game, you need to provide the config file in two locations
  • For the server, this'll be ServerStorage
  • For the client, this'll be ReplicatedStorage

Game support is not fully functional yet as the loader doesn't have RunContext tags set, this will be fixed within the first release

A reference module is this, which was used for Dropper (not open sourcing this)

return {
	Name = "Dropper",
	SourceFolder = script.Parent.Src,
	-- EntryPoint = -- point this to a module if you want that to load as your entry point
	CustomServices = { script.Parent.MCGPluginServices },
	
	Services = {
		MCGPluginServices = {
			ToolbarService = {
				Enabled = true,
				UseTranslatorService = true,
			},

			TranslatorService = {
				Enabled = true,
				Translations = script.Parent.Src.AppTranslations
			},

			Forms = {
				Enabled = true,
				FormItems = {
					script.Parent.Src.Forms.DropperMainView
				}
			},
			
			StylingService = {
				Enabled = true,
				EnableBaseStyleSheet = true
			}
		}
	}
}

This module is strictly validated.

This library is available on Wally if you'd prefer to install it that way.

Do not use the 0.1.0 release for game projects, the runtime will not work

Usage

Nekotool defines an entry point module, which is generally structured like this:

local ReplicatedStorage = game:GetService("ReplicatedStorage")
local Nekotool = require(ReplicatedStorage.Packages.Nekotool)

return Nekotool.extend(function(program)
  program.Init(function()
	  print("Hello Nekotool!")
	end)
end)