Raised This Month: $ Target: $400
 0% 

[BETA] Client-Side SourceMod Scripting API Reference


Post New Thread Reply   
 
Thread Tools Display Modes
RumbleFrog
Great Tester of Whatever
Join Date: Dec 2016
Location: US
Old 03-12-2020 , 11:06   Re: [BETA] Client-Side SourceMod Scripting API Reference
Reply With Quote #21

Quote:
Originally Posted by kadet.89 View Post
Would be nice to have comments like in the old API:

https://sm.alliedmods.net/api/index....ad=show&id=44&
https://sm.alliedmods.net/api/index....ad=show&id=87&
https://sm.alliedmods.net/api/index....ad=show&id=69&
https://sm.alliedmods.net/api/index....d=show&id=829&

We could add examples to just copy and past them to own plugins or describe some features and nuances.
Or automatically generate links to plugins where a specific function is used, something of that kind:

Need an example?, here are all plugins where "Teleport" function is used: https://www.sourcemod.net/plugins.ph...eport&search=1
I don't think that's viable ATM, and here's my reasoning.

This documentation is designed to be entirely client-side, with networking being required only when loading to cache parsed documentation. Adding comments would require a server-side data store and frequent comments fetching.

The second thing would be moderation, with login, an account is preferably required, which requires secure server-side data store. And determining which comment is appropriate requires more labor work.

Going forward, I believe any necessary useful info should be included in the documentation body and not in comments so that it can be viewed even if they don't use this documentation site.
__________________


Fingerprint: 91CC4E84AE4BFA89F2E431DD462F405E7D61ED35

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

Github: https://github.com/rumblefrog


Last edited by RumbleFrog; 03-12-2020 at 11:08.
RumbleFrog is offline
RumbleFrog
Great Tester of Whatever
Join Date: Dec 2016
Location: US
Old 04-01-2020 , 23:57   Re: [BETA] Client-Side SourceMod Scripting API Reference
Reply With Quote #22

v0.18.0


Changes:
  • Applied sorting weights for symbol types in the search view
__________________


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 04-27-2020 , 01:22   Re: [BETA] Client-Side SourceMod Scripting API Reference
Reply With Quote #23

While pending the packaging overhaul, another suggestion was raised by nosoop (I believe). That I should include other tools/utilities not limited to documentation, I think that's a great idea, going forward having utilities such as handles dump parser, vprof visualizer all in the same accessible place would be beneficial.

That being said, I'm looking for potential sourcemod utility ideas to be included, all these utilities will be compiled as separate modules to be lazy-loaded in when needed to avoid bloating the core website.
__________________


Fingerprint: 91CC4E84AE4BFA89F2E431DD462F405E7D61ED35

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

Github: https://github.com/rumblefrog

RumbleFrog is offline
Peace-Maker
SourceMod Plugin Approver
Join Date: Aug 2008
Location: Germany
Old 04-27-2020 , 07:43   Re: [BETA] Client-Side SourceMod Scripting API Reference
Reply With Quote #24

Seeing you're way more skilled in web development, I'd love to see a more usable and nicer UI for disassembling .smx files in the browser. I've created something that kinda works, but there's much more potential in here.

https://peace-maker.github.io/source...assembler-web/
https://github.com/peace-maker/sourc...isassembler-js
https://github.com/peace-maker/sourc...sassembler-web

When will you publish the web part of this project? Code is never "finished" I was searching for some "Fork me on Github.com" button on sourcemod.dev.
__________________
Peace-Maker is offline
RumbleFrog
Great Tester of Whatever
Join Date: Dec 2016
Location: US
Old 04-27-2020 , 13:49   Re: [BETA] Client-Side SourceMod Scripting API Reference
Reply With Quote #25

Quote:
Originally Posted by Peace-Maker View Post
Seeing you're way more skilled in web development, I'd love to see a more usable and nicer UI for disassembling .smx files in the browser. I've created something that kinda works, but there's much more potential in here.

https://peace-maker.github.io/source...assembler-web/
https://github.com/peace-maker/sourc...isassembler-js
https://github.com/peace-maker/sourc...sassembler-web

When will you publish the web part of this project? Code is never "finished" I was searching for some "Fork me on Github.com" button on sourcemod.dev.
I actually have something experimental that is made in Rust (https://github.com/rumblefrog/smx-dasm-rs), it's been used a few times in my other projects, but it can compiled to WASM and be included.

Regarding the UI source, It probably won't be published until after the packaging overhaul, or at least stable 1.0.0. There are a few things I want to get in before stable, pretty much everything that's on my Github project board right now: https://github.com/users/rumblefrog/projects/1
__________________


Fingerprint: 91CC4E84AE4BFA89F2E431DD462F405E7D61ED35

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

Github: https://github.com/rumblefrog


Last edited by RumbleFrog; 04-27-2020 at 13:59.
RumbleFrog is offline
Peace-Maker
SourceMod Plugin Approver
Join Date: Aug 2008
Location: Germany
Old 04-27-2020 , 17:23   Re: [BETA] Client-Side SourceMod Scripting API Reference
Reply With Quote #26

Cool, looking forward to that.
__________________
Peace-Maker 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 01:56.


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