pshy0 / pshy_merge Goto Github PK

Add a command that triggers invalid events players could theoretically send to the module, to test if it survives it (can also be tested a compile/test time).

!colorpicker show color chosen by player to command caller

Currently, a table lists all commands that modules add into it.

Instead, modules could have a commands table in their module table.
This would make command definitions independent from the module listing them, and allow to identify to what module a command belongs.

This would also make the code briefer and simpler.

Also, with this change, commands from disabled modules could be made to be disabled (except for commands such as !lobby that enables the module)

Map does not change immediately upon useing !skip.

The !getxml command could be made more convenient by the use of a smaller font.

Stop increasing scores when the animation is about to end.

Add easy ways for maps to add triggers and actions - perhaps even scripting features.

Unknown tokens such as != currently cause the compilation to fail.

It should only cause the minification to fail.

Allow FunCorp players to use the !adminme command when the script is run in FunCorp mode.

This is not yet possible due to missing api features.
This issue serves as a reminder for when the feature is available.

There have been too many times where this would have been useful.

Error messages

Failed to update mapinfo.mapinfo (Pshy#3752.lua:6451: bad argument: string expected, got nil, map @6115605)

Some bonuses could be made to play a sound.

For instance, the ice bonus should play the "mouse being frozen" sound.

Those variables should be renamed.
This requires updating dependent modules.

Maps that are called lists:
command_list: command_map or command_dictionary
Using "dictionary" would prevent confusions with the game's concept of maps.

Misspelled:
modules_list: module_list

Describe the bug
!next using a category name that does not exist causes the error map to play

Expected behavior
It should display an error when the command is entered and do not attempt to play this map.

...unless a better idea arises.

TLC stands for Transformice Lua Compiler.
It's more descriptive of what this project is for.

This may involve major changes, including changes required to be done in dependencies. As such, this is delayed to v1.0.

When I implemented the bonus module, I wanted to allow to change different settings per bonus so that a common algorithm would be able to handle them all.

The result is that bonuses are easy to add, but anything that is not supported by the main algorithm will be harder to add or more expensive in performances.
Also, the color code system to determine custom bonuses in maps is sub-optimal, limiting available grounds, and making it harder to identify bonus effects.
Other problems exists, this is not an exhaustive list.

Caveats
Many maps use the current system and would need to be converted to the new one.
Support for displaying those bonuses in map editors is non-existent. With the current ground system, it's at least possible to see where you are putting the bonuses.
In the meantime, this issue serves as a reminder, as this huge change is not a priority.

Kill afk pacmouses in PacMice

A fix is currently implemented to account for changes in the physic speed unit used by some of TFM's Lua api functions.
Because it's not going to be reverted, this fix should be removed and all scripts upgraded.

Currently, a table lists all help pages, to which modules add theirs.

Instead, modules tables could have fields describing the module directly.

This would make the code simpler.
Such table could also act as documentation, at the beginning of each file.

I had this in my personal TODO list.
This might be fixed already. Still needs to be tested.

The current !sound command would cause two musics to play on each other.

Instead, !music should stop the previous played music.
Additionally, a number could be used as an alternative for music names.

Because they have more features than just being commands, they should be moved either to tools or bases.

The image on the map from this script does not display in the right location:

map = [[<C><P F="0" MEDATA="2,1;;;;-0;0:::1-"/><Z><S><S T="6" X="727" Y="196" L="160" H="30" P="0,0,0.3,0.2,140,0,0,0"/><S T="6" X="400" Y="370" L="600" H="60" P="0,0,0.3,0.2,0,0,0,0"/><S T="13" X="193" Y="323" L="10" P="1,0,0.3,0.2,20,0,1,1" o="D3D3D3" col="" i="-5,-5,17bf4c421bb.png" tint="FF0000"/><S T="6" X="760" Y="370" L="80" H="60" P="0,0,0.3,0.2,0,0,0,0"/><S T="6" X="40" Y="370" L="80" H="60" P="0,0,0.3,0.2,0,0,0,0"/><S T="6" X="595" Y="244" L="160" H="30" P="0,0,0.3,0.2,180,0,0,0"/><S T="6" X="42" Y="286" L="80" H="30" P="0,0,0.3,0.2,180,0,0,0"/><S T="6" X="42" Y="282" L="80" H="30" P="0,0,0.3,0.2,0,0,0,0"/><S T="6" X="279" Y="206" L="80" H="30" P="0,0,0.3,0.2,210,0,0,0"/><S T="6" X="281" Y="203" L="80" H="30" P="0,0,0.3,0.2,30,0,0,0"/><S T="6" X="595" Y="240" L="160" H="30" P="0,0,0.3,0.2,0,0,0,0"/><S T="6" X="725" Y="192" L="160" H="30" P="0,0,0.3,0.2,-40,0,0,0"/><S T="2" X="89" Y="385" L="10" H="10" P="0,0,0,1.2,0,0,0,0"/><S T="12" X="228" Y="297" L="10" H="10" P="1,0,0.3,0.2,0,0,0,0" o="C6BDBD"/></S><D><DS X="143" Y="325"/></D><O><O X="782" Y="321" C="1" P="0"/><O X="708" Y="321" C="0" P="0"/><O X="398" Y="321" C="6" P="0"/><O X="489" Y="337" C="34" P="0"/><O X="539" Y="336" C="97" P="0"/><O X="623" Y="200" C="95" P="0"/></O><L/></Z></C>]]
tfm.exec.newGame(map)

Playing this map causes this error:

ASSERTION FAILED
passed a null inner_xml to GetParam
stack traceback:
	Pshy#3752.lua:4175 in function assert
	Pshy#3752.lua:5994 in function GetParam
	Pshy#3752.lua:6014 in function UpdateFromXML
	Pshy#3752.lua:6202 in function ?
	pcall in function pcall
	Pshy#3752.lua:6206 in function Update
	Pshy#3752.lua:6213 in function func
	Pshy#3752.lua:249 in function func
	Pshy#3752.lua:249 in main chunk

The script does not crash. The map's XML is apparently non-standard. This may be fixable by mapcrews.

I earlier made an attempt at using Lua metatables to simulate classes and improve code maintainability.
An official standard way of doing so existed, and it was also done in some other TFM scripts.

Unfortunately, this had a very bad performance impact.
Metatables cause some algorithms to be as bad as 2 or 3 times more expensive at runtime.

Additionally, while the technique make a code LOOKS LIKE object oriented, it actually is not, which is misleading.
Also, the readability of the class code itself is questionable.

Therefore, to provide better performances and unify how my code looks like, I will be reverting those changes, and not implementing any new metatable.

Add a way to run TLC from anywhere, without the need of including it as a submodule (so it's only a dependency).

Module name changes to unexpected value when a new player join.

This is a list of a few optimizations that can be done to the rotation system:

• #5
• When items only appear in the same order, only use a index instead of additional lists.
• Instead of popping an item from the list, move the last item to the location where an item was popped.
• Fill up the next rotation index table progressively, as items are popped, instead of doing it in one go.

Existing FC scripts causes a team to when upon reaching a certain score.

This makes the duration of the animation unpredictable, as teams can be either balanced or uneven.

A script could count rounds instead, so that an animation have a predictable duration. The last point must still be made by the winning team, so the winner is only determined at the very end.

Compiler should tell about where to find the failing script.
It may also display the failing lines.

This would make identifying the exact script version easier.

This is not going to be useful yet.

Some modules rely on eventNewPlayer.
They will not see the event while they are disabled, which could cause issues in the future.

Refactor the rain module so that it handles map size and handles different frequencies for spawned objects.

With an alias, since the second is always more useful?

Forgetting to close a markup can mess up the game's chat.
A function to assert room admins don't fail their html messages would help.

Add a button for players to not show the background images

Allow a command to be an alias for a command and parameters.

!adminme should prompt the funcorps to add the player as admin if they would be allowed in a non-funcorp room.

Some commands can be split further:

• Sound commands could go together (also add a separate !music command).
• Chat related commands.
• Commands to get infos on the scripts like !modules or !version.

A module exists to add custom emoticons.

However, this is now possible to do in game, so much less useful.
It can still be used for emotes that are not yet added, or to display an emote over someone else.

Many players also cannot use emotes from this module due to not having a numpad.

Possible improvements:

• Bind the two keys after Zero to emotes
• Let players choose what emote to bind to those keys