[RumbleFrog]

SourceMod Scripting API Reference


A new API reference is designed as a pure client-side alternative to the current 1.7 API reference, packing more features and fixes.


Feature Highlights

• Enum Struct Support
• Third party libraries support; you may select to load a library from a list of popular libraries
• Import your own pre-processed includes; you can now use your inc or use one of the already pre-processed community contributed to be rendered with this documentation
• Mobile support; the responsive design allows the documentation to be used on any device viewport
• Dark theme; woo!
• Fast and responsive; symbols are loaded into memory and entirely local
• Improved search; you can search via symbol names, parameters or its return type
• Improved type resolving in signatures; during runtime, it will attempt to resolve types with links
• Exposed additional info in symbols; arguments default values, explicit enum values, and methodmap inheritance are now exposed for the documentation
• Offline support; since it's pure client-side, you could use it offline if cached/saved and in the future service worker may be added to assist with that
• Improved and fixed-route resolution; symbol routes are now cased and type sensitive
• Base auto-updating; base SM includes will automatically check for updates every 7 days and replace its store

Repositories

• docgen - Responsible for generating/pre-processing include and manifest files
• manifest - Store of manifests and generated bundles of libraries

Previews

Desktop View

Mobile View

Search By Parameters

Import 3rd Party Includes

Include View

Definition View: Function/Method

Hosted Instance

https://sourcemod.dev

Special Attribution

These individuals helped along the process with adding to the exp compiler and docgen

• SlidyBat
• maximsmol

[RumbleFrog]

Reserved.

[Maxximou5]

This is awesome! Best of all, you did dark theme in the first beta release.

[RumbleFrog]

v0.13.0


This update is a breaking change and will require you to purge storage via the Advanced page (Extras dropdown)


Changes:

• Methodmap inheritance now shown
• Typedef and typeset preprocessing has been moved to docgen instead of during runtime (breaking schema change)
• Slight speed improvement to symbol lookups

[RumbleFrog]

Domain Change


The hosted instance has been moved to a new domain: https://sourcemod.dev

[ImACow]

Nice!

Can we have a light theme too? =D

[RumbleFrog]

Originally Posted by ImACow Nice! Can we have a light theme too? =D

It's in progress, however, I'm having some technical challenges and may take longer than expected.

[RumbleFrog]

v0.14.0


Changes:

• You can now search directly from the address bar

[RumbleFrog]

v0.15.0 - 0.16.0


Changes:

• Anchor links has been added to the right of typeset views, this is especially designed for long typeset like SDKHookCB
• Set NTV optional markers has been excluded in future imports

[RumbleFrog]

Looking for more feedback and potential changes before I move this project out of beta!

Light theme is still planned, however the framework is lacking CSS variables and I'm waiting for the maintainer to add it.