Code Monkey home page Code Monkey logo

rtfm's Introduction

RTFM

Read The Fabulous Manual, a library mod for mindustry.

Allows mods to add manual pages to the About menu.

How to use

All manuals

Click the Manuals button in Database -> About. (in the main menu)

Alternatively, install deltanedas/ui-lib and click Manuals in More or in-game.

Logic Manual

All processors have a shortcut button to read the logic instructions manual.

How to use in a mod

Read RTFM/Getting Started.

License

Licensed under the GNU GPL v3, see COPYING The sample script is in the public domain.

rtfm's People

Contributors

bergiu avatar carlosnet85 avatar deltanedas avatar king-br avatar ksf avatar philosophist avatar skybldev avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

rtfm's Issues

Socket closed

Everytime i try to install dis mod i pops up with a socket closed notice ...im on phone and idk coding

crash

Every time I try to open mindustry with this on IT CRASHES

radar sort property is missing and wrong order

the radar command has a property called sort which is missing and the parameters are in the wrong order. values of the sort property can be: distance, health, shield, armor or maxHealth.

GUI:
2021-11-09_01-29

The above block in code is the following:
radar enemy any any distance turret1 1 result

This is the current documentation:
2021-11-09_01-29_1

The documentation should look like this:
radar TargetType prop1, prop2, prop3, SortType sort, Ranged turret, Val output

With external game translation bundle loaded, got File not found: manuals\$rtfm.docs.title\$rtfm.docs.getting-started

I tried to install from Import From Github and manually download from github.
Is it a Mindustry bug?

[I] [JAVA] Version: 1.8.0_221
[I] NOTE: external translation bundle has been loaded.
[I] Loaded mod 'rtfm' in 18.7664ms
[E] rhino.WrappedException: Wrapped arc.util.ArcRuntimeException: File not found: manuals\$rtfm.docs.title\$rtfm.docs.getting-started (internal) (global.js#8)
        at rhino.Context.throwAsScriptRuntimeEx(Context.java:1668)
        at rhino.MemberBox.invoke(MemberBox.java:127)
        at rhino.NativeJavaMethod.call(NativeJavaMethod.java:205)
        at rhino.optimizer.OptRuntime.call1(OptRuntime.java:23)
        at rhino.gen.global_js_1._c_anonymous_2(global.js:8)
        at rhino.gen.global_js_1.call(global.js)
        at rhino.ArrowFunction.call(ArrowFunction.java:33)
        at rhino.optimizer.OptRuntime.callName(OptRuntime.java:51)
        at rhino.gen.library_4._c_anonymous_2(library:31)
        at rhino.gen.library_4.call(library)
        at rhino.ArrowFunction.call(ArrowFunction.java:33)
        at rhino.optimizer.OptRuntime.callName(OptRuntime.java:51)
        at rhino.gen.library_4._c_anonymous_7(library:78)
        at rhino.gen.library_4.call(library)
        at rhino.optimizer.OptRuntime.callN(OptRuntime.java:41)
        at rhino.gen.library_4._c_anonymous_9(library:135)
        at rhino.gen.library_4.call(library)
        at rhino.optimizer.OptRuntime.call2(OptRuntime.java:32)
        at rhino.gen.docs_7._c_script_0(docs:21)
        at rhino.gen.docs_7.call(docs)
        at rhino.gen.docs_7.exec(docs)
        at rhino.module.Require.executeModuleScript(Require.java:321)
        at rhino.module.Require.getExportedModuleInterface(Require.java:272)
        at rhino.module.Require.call(Require.java:202)
        at rhino.optimizer.OptRuntime.callName(OptRuntime.java:51)
        at rhino.gen.main_js_3._c_anonymous_1(main.js:19)
        at rhino.gen.main_js_3.call(main.js)
        at rhino.optimizer.OptRuntime.call0(OptRuntime.java:15)
        at rhino.gen.main_js_3._c_script_0(main.js:0)
        at rhino.gen.main_js_3.call(main.js)
        at rhino.ContextFactory.doTopCall(ContextFactory.java:346)
        at rhino.ScriptRuntime.doTopCall(ScriptRuntime.java:3303)
        at rhino.gen.main_js_3.call(main.js)
        at rhino.gen.main_js_3.exec(main.js)
        at rhino.Context.evaluateString(Context.java:1070)
        at mindustry.mod.Scripts.run(Scripts.java:169)
        at mindustry.mod.Scripts.run(Scripts.java:159)
        at mindustry.mod.Mods.lambda$loadScripts$18(Mods.java:440)
        at arc.struct.Seq.each(Seq.java:193)
        at mindustry.mod.Mods.eachEnabled(Mods.java:576)
        at mindustry.mod.Mods.loadScripts(Mods.java:428)
        at mindustry.ClientLauncher.lambda$setup$4(ClientLauncher.java:92)
        at arc.assets.AssetManager$1.loadSync(AssetManager.java:334)
        at arc.assets.AssetLoadingTask.handleAsyncLoader(AssetLoadingTask.java:109)
        at arc.assets.AssetLoadingTask.update(AssetLoadingTask.java:74)
        at arc.assets.AssetManager.updateTask(AssetManager.java:591)
        at arc.assets.AssetManager.update(AssetManager.java:440)
        at arc.assets.AssetManager.update(AssetManager.java:465)
        at mindustry.ClientLauncher.update(ClientLauncher.java:137)
        at arc.backend.sdl.SdlApplication.listen(SdlApplication.java:158)
        at arc.backend.sdl.SdlApplication.loop(SdlApplication.java:146)
        at arc.backend.sdl.SdlApplication.<init>(SdlApplication.java:43)
        at mindustry.desktop.DesktopLauncher.main(DesktopLauncher.java:36)
Caused by: arc.util.ArcRuntimeException: File not found: manuals\$rtfm.docs.title\$rtfm.docs.getting-started (internal)
        at arc.files.Fi.read(Fi.java:199)
        at arc.files.Fi.length(Fi.java:868)
        at arc.files.Fi.estimateLength(Fi.java:312)
        at arc.files.Fi.readString(Fi.java:275)
        at arc.files.Fi.readString(Fi.java:266)
        at mindustry.mod.Scripts.readString(Scripts.java:84)
        at sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method)
        at sun.reflect.NativeMethodAccessorImpl.invoke(Unknown Source)
        at sun.reflect.DelegatingMethodAccessorImpl.invoke(Unknown Source)
        at java.lang.reflect.Method.invoke(Unknown Source)
        at rhino.MemberBox.invoke(MemberBox.java:105)
        ... 51 more
[E] [rtfm/main.js]: WrappedException: Wrapped arc.util.ArcRuntimeException: File not found: manuals\$rtfm.docs.title\$rtfm.docs.getting-started (internal) (global.js#8)

Stuck on instructions page

After the instruction manual is opened from a processor GUI, all other buttons to open the manual open there with no way to access other pages

Button not working

On v7 (specifically 128) the RTFM buttons don't show up. Can you try testing it and fix it?

No apparent change in UI after install on iOS

After installing the mod (v2.14.6) on iOS (121.4) I can find no way of accessing the manual. There is no About dialog I have been able to find on the main splash screen to contain a 'Manuals' option.

ui-lib (v2.16.6) was also installed, but again seemed to have no impact, either on the main menus, or the in-game controls.

Failed to build two pages

The following pages fail to build, with the given error displayed in the middle of the screen vertically, on the left side:

  1. RTFM Docs / Manual Format
    TypeError: Cannot find function join in object #. (builder#151(eval)#1)

  2. Modding / Units
    InternalError: TypeError: redeclaration of var u. (builder#151(eval)#1) (builder#151(eval)#1)

Before filing this bug report, I made sure to remove all mods from my game install and then only add the ui-lib and rtfm mods, to both make sure they were the newest version and to prevent any possible clashes from other mods being the problem.

I'm using Mindustry version 122, specifically the Mindustry.jar file downloaded from the release on Github.

My operating system is KDE Neon, which is based on Ubuntu 20.04. I run the game through the OpenJDK Java 11 runtime, with this being the output of java -version:

Picked up _JAVA_OPTIONS: -Dswing.aatext=true
openjdk version "11.0.9.1" 2020-11-04
OpenJDK Runtime Environment (build 11.0.9.1+1-Ubuntu-0ubuntu1.20.04)
OpenJDK 64-Bit Server VM (build 11.0.9.1+1-Ubuntu-0ubuntu1.20.04, mixed mode, sharing)

RTFM not working

Mindustry version 140.4

So, the option to browse RTFM in the main menu is gone, and now that ui-lib is unsupported, there seems to be no way to actually view RTFM. Am I missing something? Or is this mod dead until an update fixes either of the issues I mentioned above?

Yup

изображение
add setting to hide this button/hide automatically on pc?

uradar documentation not correct

There is a hidden parameter and the sort and order parameters are in the wrong order.

Docs:
image

GUI:
2021-11-09_02-18

Code:
uradar enemy any any distance 0 1 result

Maybe correct documentation:
radar Target a, b, c, SortType sort, 0, bool order, Healthc result
I'm unsure about how to document a parameter that is irrelevant.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.