Intro (API)

ARCropolis API

The ARCropolis API offers a variety of functions to plugin developers, such as file (both stream and non-stream) callbacks, checking whether a specific file is loaded or not, events for running code when either the Arc Filesystem or the Mods Filesystem is mounted, showing the mod manager from another plugin, checking whether a mod is enabled or not, and many more!

This section will introduce developers to the Arcropolis API. Readers are expected to have at least a basic understanding of Rust and Skyline plugins beforehand, as you will be lost without understanding those core concepts.

First off, we need to add the arcropolis_api crate to our Cargo.toml file:

[dependencies]
arcropolis-api = { git = "https://github.com/Raytwo/arcropolis_api" }

Any time you need to update this, you can do so with the following command:

cargo update -p arcropolis-api

Now onto actually using it!