y785 / script-api Goto Github PK

A java MapleStory🍁 scripting api.

License: MIT License

Java 100.00%

script-api's Introduction

❤ Moe Script API

This is a fluent script api for writing performant, low overhead, MapleStory scripts. We do this by constructing proxy objects that communicate between the api and the script files. The API itself is heavily modelled after nexon's own api, with some minor additions here and there, like text command scripts. Credits to bboki/feras for the below image

Maven

<dependency>
  <groupId>moe.maple</groupId>
  <artifactId>script-api</artifactId>
  <version>1.6.0</version>
</dependency>

Examples

For a more in depth explanation, see the wiki. All scripts extend their base script type, so a script for an Npc would extend the NpcScript, etc. Additionally, all logic is conducted in the Script::work() method. You shouldn't have to extend any underlying logic methods to have functioning scripts, for a more detailed explanation or outlook on scripts, see my main script repo.

script-api's People

Contributors

Stargazers

Watchers

Forkers

koreanmush oung maplestory-archive thewoif777 easy-forks blackmaple2018 gmh5225

script-api's Issues

Tuple utility functions with same type

Example
<T> Tuple<T,T>[] for(T... pairs)

More Script Actions

Need to expand upon say/askMenu/askYesno to include all the default types.

This is more about adding the messengers with correct/needed parameters.

Missing:

SayImage
AskText
AskNumber
AskQuiz
AskSpeedQuiz
AskAvatar
AskMemberShopAvatar
AskPet
AskPetAll
Script(?)
AskAccept
AskBoxText
AskSlideMenu
AskCenter(?)

Wiki needs examples and how-to

title

Script name based on call

There isn't a way to determine the script name being called.
Normally this isn't needed, but since I added aliases (multiple names -> single script), it is.

This is similar to how the notfound scripts work.

Add script validators

Script validators should validate various things passed to them.
Hair ids, npc ids, etc etc.

Should default to true -- trust the scripts.

Will be useful for various between-version issues.

Collection<> for every varargs...

I'd like if there was collection support where varargs are supported on all script methods.

MessageType conversion for older versions

Need to add a way for older versions to offset the script types based on version, or just set them.

ScriptStringBuilder 'newline' returns ScriptMenuBuilder

Should be a relatively simple fix, but it needs fixing nonetheless.

Consecutive responsive actions cause crashes

Calling two script actions (i.e. say, askYesNo) consecutively may result in messengers sending packets too soon.
Typical usage of the API would look like the below, chained together with andThen

askYesNo("...",()->{...}).andThen(()->say(...))

Erroneous usage would look like

askYesNo("...",()->{...});
say(...);

This should throw an exception.

SayMessenger default logs out of order

Parameters just need to be switched around 🙂

askMenu index issues

askMenu doesn't use always use the indices sent to the client, it uses an array's. This will cause the script to end on custom indices being sent to the client, i.e.
\#L0# test #lr\n#L1000# test #l
-> The client will send 1000, but the server thinks the max is 1.

SpeakingScript tests

Tests for most SpeakingScript functions have yet to be written.

Inventory exchange int varargs

Could be something like
default exchange(int... args) { exchange(Tuple.listOf(args)); }

BiConsumer forEach for Tuples

tuple.forEach((left, right)->x
See https://docs.oracle.com/en/java/javase/12/docs/api/java.base/java/util/Map.html#forEach(java.util.function.BiConsumer) for an example

Add Client format methods to ScriptStringBuilder

As of right now, Moematter has methods like item() to create strings with the MapleStory client's formatting options.
I'd like shortcuts inside ScriptStringBuilder to append them.
ssb.item(1302000) would equate to ssb.append(Moematter.item(1302000))