Skip to content

Converted Scripting pages from wiki to mkdocs#19

Open
llchrisll wants to merge 8 commits into
rathena:masterfrom
llchrisll:docs/scripting
Open

Converted Scripting pages from wiki to mkdocs#19
llchrisll wants to merge 8 commits into
rathena:masterfrom
llchrisll:docs/scripting

Conversation

@llchrisll

@llchrisll llchrisll commented May 27, 2026

Copy link
Copy Markdown

Converted all available pages from rAthena Wiki regarding scripting.
Also updated the Deploy_Guides.yml regarding GitHub Pages artifacts being outdated.

ToDo:

  • Finish formating to suit mkdocs style
  • Check links (I believe I got all, but need to recheck)

Live Demo can be viewed here.
The workflow is manually executed based on the docs/scripting branch.

If anybody still has older mediawiki pages, let me know so I can add them if needed.

llchrisll added 7 commits May 27, 2026 14:44
- Fixed a small linkage issue in README.md related to the CONTRIBUTE located in guides folder, not the root folder.
- Fixed another linkage issue in installing.md, adding the "installing" path to docker and debian.
- Added the mysql.md based on [this](https://github.com/rathena/rathena/wiki/Install-MySQL)
Update GitHub Pages artifact to v3
Revert last commit

@Danil0v3s Danil0v3s left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why is the script_commands left out? xD

Are you planning on doing it on a following PR?

Comment thread guides/scripting/monster-spawn.md Outdated
Script Syntax
-------------

> string\[32\](*map_name*),ushort(*x*),ushort(*y*)\[,short(*x2*) = 0\[,short(*y2*) = 0\]\] <TAB> **monster** string\[24\](*name*) <TAB> short(*mob_id*),ushort(*amount*)\[,uint(*delay*)= 0\[,uint(*variance*) = 0\[,string\[50\](*event*)\] = null\]\]

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this should be using code blocks instead

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Like mentioned in the main post, I still need to format most files.

@llchrisll

Copy link
Copy Markdown
Author

It's linked to the script_commands.txt, should be enough xD.

I mean I won't copy & paste it.

@Danil0v3s

Copy link
Copy Markdown
Contributor

It's linked to the script_commands.txt, should be enough xD.

I mean I won't copy & paste it.

Following that line of thought we could just link everything back to txt, couldn't we?

@llchrisll

llchrisll commented May 27, 2026

Copy link
Copy Markdown
Author

Na that was just like it was originally on the wiki, also those pages should represent a guide itself not just links.

The only thing are the commands themself which are basically explained there already.

@Danil0v3s

Copy link
Copy Markdown
Contributor

Na that was just like it was originally on the wiki, also those pages should represent a guide itself not just links.

The only thing are the commands themself which are basically explained there already.

Just so I don't hijack your PR, here's what claude yield when I asked it to follow your format fo the script_commands.txt
script_commands.zip
Screenshot 2026-05-27 at 23 41 56

@llchrisll

Copy link
Copy Markdown
Author

Well technically it would end up up the decision of Akky and others if they want that or not.

Cuz if there will be new script commands or similar those would need to be updated again it's just linking to the actual txt file.

@Danil0v3s

Copy link
Copy Markdown
Contributor

Well technically it would end up up the decision of Akky and others if they want that or not.

Cuz if there will be new script commands or similar those would need to be updated again it's just linking to the actual txt file.

What you mean, others? I'm the others as well xD I can approve/merge this or deny. I wouldn't be wasting my time reviewing PRs if I couldn't

@llchrisll

Copy link
Copy Markdown
Author

Well, I don't know if you have discussions about PR's (except maybe smaller ones) or not.
Also I don't really pay attention who can merge/approve them anyway.
I only remembered Akky and lemongrass at that point, so I'm sorry if I offended ya somehow.


Regarding script_commands.txt, I don't really care if that's also included.
I only wanted to contribute by adding a start of the "scripting" section from the wiki.

Personally I'm using the file itself look up stuff not the wiki in that regard.
If you want me to add it, feel free to send those files and I will add them, and no I will not use AI myself, as I personally reject using AI as much as possible.

But like I meant, personally I don't see the point in that, that's why I didn't add them directly.

@llchrisll

Copy link
Copy Markdown
Author

Different thing, how would you view these Annotations from mkdocs?
image
Would that be something to look into or should that be avoided?

@Danil0v3s Danil0v3s marked this pull request as draft May 30, 2026 16:27
@Danil0v3s

Copy link
Copy Markdown
Contributor

Well, I don't know if you have discussions about PR's (except maybe smaller ones) or not. Also I don't really pay attention who can merge/approve them anyway. I only remembered Akky and lemongrass at that point, so I'm sorry if I offended ya somehow.

Regarding script_commands.txt, I don't really care if that's also included. I only wanted to contribute by adding a start of the "scripting" section from the wiki.

Personally I'm using the file itself look up stuff not the wiki in that regard. If you want me to add it, feel free to send those files and I will add them, and no I will not use AI myself, as I personally reject using AI as much as possible.

But like I meant, personally I don't see the point in that, that's why I didn't add them directly.

I'll be converting it back to draft then, since you're still actively working on it! When you're done and ready to merge you mark it as ready for review again, please.

Different thing, how would you view these Annotations from mkdocs? image Would that be something to look into or should that be avoided?

These should be fine I guess? most docs use these as well

@llchrisll

llchrisll commented May 30, 2026

Copy link
Copy Markdown
Author

Alright thanks, I'm nearly done via basic formating.
Only the Overview of Errors page left.
I can fine tune it later if wanted.

I just tried the annotate thingy on error page:
image
Looks neat I guess?
2nd one is the current layout.

Wanted to make sure first, because that file has 2531 lines total xD.

@llchrisll llchrisll marked this pull request as ready for review June 3, 2026 12:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants