Raised This Month: $2 Target: $400
 0% 

[BETA] Client-Side SourceMod Scripting API Reference


Post New Thread Reply   
 
Thread Tools Display Modes
Author Message
RumbleFrog
Great Tester of Whatever
Join Date: Dec 2016
Location: US
Old 01-01-2020 , 03:35   [BETA] Client-Side SourceMod Scripting API Reference
Reply With Quote #1

SourceMod Scripting API Reference


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

Note: While in the beta stage, things may be subjected to changes, breakages, and bugs. Your feedback and proposals are highly welcomed during this period.



Feature Highlights
  • Enum Struct Support
  • 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 and identical named methodmap and enumeration and now merged into one view
  • Base auto-updating; base SM includes will automatically check for updates every 7 days and replace its store


Repositories
  • sp-docgen - Responsible for generating/pre-processing include and manifest files
  • sp-manifest - Store of manifest files of include files
  • sp-gid - Store of generated include files from sp-manifest by sp-docgen, which is consumed by CDNs when tagged
  • sp-docs - Documentation UI; currently not ready to made public

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

__________________


Fingerprint: 91CC4E84AE4BFA89F2E431DD462F405E7D61ED35

Reach me @ https://keybase.io/rumblefrog

Github: https://github.com/rumblefrog


Last edited by RumbleFrog; 01-08-2020 at 13:53.
RumbleFrog is offline
RumbleFrog
Great Tester of Whatever
Join Date: Dec 2016
Location: US
Old 01-01-2020 , 03:35   Re: [RELEASE] [BETA] Client-Side SourceMod Scripting API Reference
Reply With Quote #2

Reserved.
__________________


Fingerprint: 91CC4E84AE4BFA89F2E431DD462F405E7D61ED35

Reach me @ https://keybase.io/rumblefrog

Github: https://github.com/rumblefrog

RumbleFrog is offline
Maxximou5
AlliedModders Donor
Join Date: Feb 2013
Old 01-01-2020 , 14:40   Re: [BETA] Client-Side SourceMod Scripting API Reference
Reply With Quote #3

This is awesome! Best of all, you did dark theme in the first beta release.
__________________
Maxximou5 is offline
RumbleFrog
Great Tester of Whatever
Join Date: Dec 2016
Location: US
Old 01-07-2020 , 12:11   Re: [BETA] Client-Side SourceMod Scripting API Reference
Reply With Quote #4

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
__________________


Fingerprint: 91CC4E84AE4BFA89F2E431DD462F405E7D61ED35

Reach me @ https://keybase.io/rumblefrog

Github: https://github.com/rumblefrog

RumbleFrog is offline
RumbleFrog
Great Tester of Whatever
Join Date: Dec 2016
Location: US
Old 01-08-2020 , 14:05   Re: [BETA] Client-Side SourceMod Scripting API Reference
Reply With Quote #5

Domain Change


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


Fingerprint: 91CC4E84AE4BFA89F2E431DD462F405E7D61ED35

Reach me @ https://keybase.io/rumblefrog

Github: https://github.com/rumblefrog

RumbleFrog is offline
ImACow
AlliedModders Donor
Join Date: Feb 2015
Old 01-10-2020 , 13:33   Re: [BETA] Client-Side SourceMod Scripting API Reference
Reply With Quote #6

Nice!

Can we have a light theme too? =D
__________________
ImACow is offline
RumbleFrog
Great Tester of Whatever
Join Date: Dec 2016
Location: US
Old 01-10-2020 , 19:08   Re: [BETA] Client-Side SourceMod Scripting API Reference
Reply With Quote #7

Quote:
Originally Posted by ImACow View Post
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.
__________________


Fingerprint: 91CC4E84AE4BFA89F2E431DD462F405E7D61ED35

Reach me @ https://keybase.io/rumblefrog

Github: https://github.com/rumblefrog

RumbleFrog is offline
RumbleFrog
Great Tester of Whatever
Join Date: Dec 2016
Location: US
Old 01-17-2020 , 16:50   Re: [BETA] Client-Side SourceMod Scripting API Reference
Reply With Quote #8

v0.14.0


Changes:
  • You can now search directly from the address bar




__________________


Fingerprint: 91CC4E84AE4BFA89F2E431DD462F405E7D61ED35

Reach me @ https://keybase.io/rumblefrog

Github: https://github.com/rumblefrog

RumbleFrog is offline
RumbleFrog
Great Tester of Whatever
Join Date: Dec 2016
Location: US
Old 01-19-2020 , 20:14   Re: [BETA] Client-Side SourceMod Scripting API Reference
Reply With Quote #9

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
__________________


Fingerprint: 91CC4E84AE4BFA89F2E431DD462F405E7D61ED35

Reach me @ https://keybase.io/rumblefrog

Github: https://github.com/rumblefrog

RumbleFrog is offline
RumbleFrog
Great Tester of Whatever
Join Date: Dec 2016
Location: US
Old 02-27-2020 , 03:12   Re: [BETA] Client-Side SourceMod Scripting API Reference
Reply With Quote #10

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.
__________________


Fingerprint: 91CC4E84AE4BFA89F2E431DD462F405E7D61ED35

Reach me @ https://keybase.io/rumblefrog

Github: https://github.com/rumblefrog

RumbleFrog is offline
Reply


Thread Tools
Display Modes

Posting Rules
You may not post new threads
You may not post replies
You may not post attachments
You may not edit your posts

BB code is On
Smilies are On
[IMG] code is On
HTML code is Off

Forum Jump


All times are GMT -4. The time now is 15:21.


Powered by vBulletin®
Copyright ©2000 - 2020, vBulletin Solutions, Inc.
Theme made by Freecode