MiniScript Wiki - User contributions [en]

Open-Source Projects

2021-02-02T04:07:51Z

Mantic: Added minimicro-tiled link!

This page is a collection of links to open-source projects in or for MiniScript.

=== Main Repository ===
https://github.com/JoeStrout/miniscript

Official repository of source code for the MiniScript language (both C# and C++ versions), as well as [[Command-Line MiniScript]].

=== Kotlin version of MiniScript ===
https://github.com/Arcnor/miniscript-kt

A third-party reimplementation of MiniScript in Kotlin (a more modern Java-like language which runs on the JVM).

=== MiniScript in RayLib ===
https://github.com/AlRado/Raylib-cs-Examples/tree/miniscript

Adds MiniScript support to RayLib-cs, an open-source C# game engine.

=== MiniScript in MonoGame ===
https://github.com/guiprada/monomicro

Adds MiniScript support to MonoGame, another open-source C# game engine.

=== GameLodge ===
https://github.com/bananaHemic/gamelodge_unity

A multiplayer VR project that supports online coding & development based on MiniScript. Edit the game while people are in it!

=== Editors & Syntax Highlighting ===

==== NotePad++ UDL ====
https://github.com/SynapticBytes/MiniScript-UDL-for-Notepad-plus-plus

User-Defined Language for the NotePad++ text editor for Windows.

==== VS Code Language Module ====
https://bitbucket.org/colinmac/miniscript-syntax/src/master/

Provides MiniScript syntax highlighting for Visual Studio Code.

==== BBEdit Language Module ====
https://github.com/JoeStrout/miniscript-bbedit-lang-mod

Provides MiniScript syntax highlighting for the BBEdit text editor for macOS.

==== Pygments fork ====
https://github.com/JoeStrout/pygments

Fork of the Pygments syntax-coloring library which adds support for MiniScript.
[https://github.com/pygments/pygments/pull/1397 Merged] into the main Pygments repo on Feb. 29, 2020.

==== Highlight.js Package ====
https://github.com/JoeStrout/highlightjs-miniscript

Add-on language module for [https://github.com/highlightjs/highlight.js Highlight.js].

=== MiniScript code libraries ===

==== minimicro-fonts ====
https://github.com/JoeStrout/minimicro-fonts

Provides support for colored, proportional or monospaced screen fonts in BMF format.

==== minimicro-tiled ====
: Provides a [https://www.mapeditor.org/ Tiled] map importer and renderer!
: https://github.com/Mantic/minimicro-tiled

=== Games/Apps/Programs written in MiniScript ===

* '''Annelids''': https://github.com/JoeStrout/annelids

File.readLines

2021-01-24T04:21:41Z

Mantic: Initial file.readLines page.

In [[Mini Micro]] and [[command-line MiniScript]], the <c>[[file]].readLines</c> function reads a file into an array of strings.

<c>file.readLines</c> will return ''null'' on any file it cannot open or read.

=== Arguments ===

{| class="wikitable"
|-
! Parameter Name !! Meaning
|-
| filePath || an absolute or relative path of the file to be read.
|}

See also: [[file.writeLines]]

== Example ==

<ms>fileName = "myfoods.txt"
foods = file.readLines(fileName)

if foods == null then
print "[" + fileName + "] cannot be read."
else
print "My favorite foods are: "
for i in range(0, foods.len-1)
print " " + foods[i]
end for
end if
</ms>

[[Category:Mini Micro]]
[[Category:Command-Line MiniScript]]

File.writeLines

2021-01-24T04:03:08Z

Mantic: Initial file.writeLines page.

In [[Mini Micro]] and [[command-line MiniScript]], the <c>[[file]].writeLines</c> function writes a single value, or an array of values, to a file.

<c>file.writeLines</c> will create or overwrite the file path passed to it. This function does not appear to return anything other then ''null''.

=== Arguments ===

{| class="wikitable"
|-
! Parameter Name !! Meaning
|-
| filePath || an absolute or relative path of the file or directory to be written to.
|-
| content || a single variable (of any type) to be written to the file. If it is an array, it will be written out with a newline after each item in the array.
|}

See also: [[file.readLines]]

== Example 1 ==

<ms>foods = [
"fish",
"grapes",
"dreams",
"head cheese",
"cucumber",
"sea cucumber",
"Welsh rabbit",
]

file.writeLines "myFavoriteFoods.txt", foods

file.writeLines "myAge.txt", 100

file.writeLines "../myParentsAge.txt", 242
</ms>

== Example 2 ==

This silly program will overwrite itself each time it is ran, incrementing the count.
Name it <c>selfcounter.ms</c> and give it a whirl!

<ms>count = 0

// Increment count and report.
count = count + 1
print "This file has been ran: " + count + " time(s)!"

// Read source code of this file, modify it, and write it back out.
code = file.readLines("selfcounter.ms")

code[0] = "count = " + count

file.writeLines "selfcounter.ms", code

// Reload entire file.
load "selfcounter.ms"
</ms>

[[Category:Mini Micro]]
[[Category:Command-Line MiniScript]]

File.exists

2021-01-24T03:39:53Z

Mantic: Initial file.exists page.

In [[Mini Micro]] and [[command-line MiniScript]], the <c>[[file]].exists</c> function checks if a file or directory exists at the specified path.

=== Arguments ===

{| class="wikitable"
|-
! Parameter Name !! Meaning
|-
| filePath|| an absolute or relative path of the file or directory to be tested.
|}

{| class="wikitable"
|-
! Return !! Meaning
|-
| 1 ''(true)'' || The file or directory exists.
|-
| 0 ''(false)'' || The file or directory does not exist.
|}

== Example ==

Test the existence of various files and directories:

<ms>if file.exists("/usr2") then print "/usr2 appears to be mounted!"
if file.exists("/usr2/myapp.ms") then print "myapp.ms is there!"

// Look for a file in the parent directory of the current working directory.
if not file.exists("../output.txt") then
file.writeLines "../output.txt", "This file will be created with this string at the top. Woot!"
else
file.writeLines "../output.txt", "This file will be overwritten with a BETTER string at the top."
end if
</ms>

[[Category:Mini Micro]]
[[Category:Command-Line MiniScript]]

File.copy

2021-01-24T03:14:01Z

Mantic: Added some known limitations on error returning.

In [[Mini Micro]] and [[command-line MiniScript]], the <c>[[file]].copy</c> function copies a file on the system.

=== Arguments ===

{| class="wikitable"
|-
! Parameter Name !! Meaning
|-
| sourceFilePath|| absolute or relative path to the source file
|-
| targetFilePath || absolute or relative path of the target file
|}

{| class="wikitable"
|-
! Return !! Meaning
|-
| null || File was copied successfully, or the source file was not found. (Use <c>[[file.exists]]</c> to check if the source file is present first.)
|-
| "Error: target file already exists" || Target file already exists. <c>file.copy</c> won't override existing files.
|-
| "Error: target disk not found" || ''targetFilePath'' cannot be navigated to, so no copy can be made.
|}

== Current limitations ==
# If you attempt to copy a file into a path, the file is not copied and no error is returned. EG: <c>file.copy "myfile.txt", "/usr2"</c>
# If you attempt to copy a directory, or to a directory, with no file names, it returns ''null'' with no error. EG: <c>file.copy "/usr2", "/usr2/copy"</c>

== Example ==

This copies a file from the current working directory, to a directory just above it:

<ms>if file.exists("myfile.txt") then

ret = file.copy("myfile.txt", "../mycopy.txt")

if ret == null and file.exists("../mycopy.txt") then
print "Copy successful!"
else
print "Copy failed: " + ret
end if

end if</ms>

[[Category:Mini Micro]]
[[Category:Command-Line MiniScript]]

File.copy

2021-01-24T02:50:05Z

Mantic: First draft of file.copy.

In [[Mini Micro]] and [[command-line MiniScript]], the <c>[[file]].copy</c> function copies a file on the system.

=== Arguments ===

{| class="wikitable"
|-
! Parameter Name !! Meaning
|-
| sourceFilePath|| absolute or relative path to the source file
|-
| targetFilePath || absolute or relative path of the target file
|}

{| class="wikitable"
|-
! Return !! Meaning
|-
| null || File was copied successfully, or the source file was not found. (Use <c>[[file.exists]]</c> to check if the source file is present first.)
|-
| "Error: target file already exists" || Target file already exists. <c>file.copy</c> won't override existing files.
|-
| "Error: target disk not found" || ''targetFilePath'' cannot be navigated to, so no copy can be made.
|}

== Example ==

This copies a file from the current working directory, to a directory just above it:

<ms>if file.exists("myfile.txt") then
ret = file.copy("myfile.txt", "../mycopy.txt")
if ret == null then
print "Copy successful!"
else
print "Copy failed: " + ret
end if
end if</ms>

[[Category:Mini Micro]]
[[Category:Command-Line MiniScript]]

Key.keyNames

2021-01-21T22:14:34Z

Mantic: Added some sample output and explanation about key.keyNames values vs key.get values.

<c>[[key]].keyNames</c> returns a list of all the key names available for use with <c>[[key.pressed]]</c>.

=== Usage Notes ===
This can be used to check all possible button-like inputs (keypresses, joystick buttons, etc). For example: if waiting for the user to press anything to continue or while configuring their input preferences.

Though some values may overlap, the values from <c>[[key]].keyNames</c> are not always the same that are received from <c>[[key.get]]</c>. Characters such as upper case letters, arrow keys, etc., as returned from <c>[[key.get]]</c> cannot be used in <c>[[key.pressed]]</c>.

== Example 1 ==

<ms>while true
for n in key.keyNames
if key.pressed(n) then print n
end for
end while</ms>

See also: <c>[[key.pressed]]</c>, <c>[[key]]</c>

== Sample Output ==
<div class="toccolours mw-collapsible mw-collapsed">
Windows 10 sample output:
<div class="mw-collapsible-content">
a
b
c
d
e
f
g
h
i
j
k
l
m
n
o
p
q
r
s
t
u
v
w
x
y
z
1
2
3
4
5
6
7
8
9
0
-
=
[
]
\
,
.
/
;
'
`
f1
f2
f3
f4
f5
f6
f7
f8
f9
f10
f11
f12
f13
f14
f15
up
down
left
right
[1]    // keypad input
[2]    // keypad input
[3]    // keypad input
[4]    // keypad input
[5]    // keypad input
[6]    // keypad input
[7]    // keypad input
[8]    // keypad input
[9]    // keypad input
[0]    // keypad input
[+]    // keypad input
[-]    // keypad input
[*]    // keypad input
[/]    // keypad input
enter
equals
clear
left shift
right shift
left ctrl
right ctrl
left alt
right alt
left cmd
right cmd
backspace
tab
return
escape
space
delete
insert
home
end
page up
page down
mouse 0
mouse 1
mouse 2
mouse 3
mouse 4
mouse 5
mouse 6
joystick button 0
joystick button 1
joystick button 2
joystick button 3
joystick button 4
joystick button 5
joystick button 6
joystick button 7
joystick button 8
joystick button 9
joystick button 10
joystick button 11
joystick button 12
joystick button 13
joystick button 14
joystick button 15
joystick 1 button 0
joystick 1 button 1
joystick 1 button 2
joystick 1 button 3
joystick 1 button 4
joystick 1 button 5
joystick 1 button 6
joystick 1 button 7
joystick 1 button 8
joystick 1 button 9
joystick 1 button 10
joystick 1 button 11
joystick 1 button 12
joystick 1 button 13
joystick 1 button 14
joystick 1 button 15
joystick 2 button 0
joystick 2 button 1
joystick 2 button 2
joystick 2 button 3
joystick 2 button 4
joystick 2 button 5
joystick 2 button 6
joystick 2 button 7
joystick 2 button 8
joystick 2 button 9
joystick 2 button 10
joystick 2 button 11
joystick 2 button 12
joystick 2 button 13
joystick 2 button 14
joystick 2 button 15
joystick 3 button 0
joystick 3 button 1
joystick 3 button 2
joystick 3 button 3
joystick 3 button 4
joystick 3 button 5
joystick 3 button 6
joystick 3 button 7
joystick 3 button 8
joystick 3 button 9
joystick 3 button 10
joystick 3 button 11
joystick 3 button 12
joystick 3 button 13
joystick 3 button 14
joystick 3 button 15
joystick 4 button 0
joystick 4 button 1
joystick 4 button 2
joystick 4 button 3
joystick 4 button 4
joystick 4 button 5
joystick 4 button 6
joystick 4 button 7
joystick 4 button 8
joystick 4 button 9
joystick 4 button 10
joystick 4 button 11
joystick 4 button 12
joystick 4 button 13
joystick 4 button 14
joystick 4 button 15
</div>
</div>

[[Category:Mini Micro]]

TextDisplay

2021-01-14T18:01:06Z

Mantic: Added it to the mini micro category so it shows up in the pages list.

The <c>TextDisplay</c> class in [[Mini Micro]] is a display type that represents a 68-column, 26-row text character display. Each row/column position in this display is called a "cell" and may display one character, with any foreground and background color (including transparent colors).

By default, [[display]] 3 is configured as a text display, and is in fact the main text display to which [[print]] prints, and to which the [[text]] global refers (unless you change it). But you can make any display layer a text display by setting its [[Display.mode|mode]] to <c>displayMode.text</c>.

There are two ways to put text into a text display: use the [[TextDisplay.print]] method, which applies the current values of [[TextDisplay.color]], etc.; or set individual cells with [[TextDisplay.setCell]], [[TextDisplay.setCellColor]], etc.

== Methods and Properties ==

{| class="wikitable"
|-
! Method or Property !! Purpose
|-
| [[TextDisplay.color]] || get or set the text color (used on subsequent [[TextDisplay.print]])
|-
| [[TextDisplay.backColor]] || get or set the background color (used on subsequent [[TextDisplay.print]])
|-
| [[TextDisplay.column]] || get/set the cursor column, 0-67 (where subsequent [[TextDisplay.print]] begins)
|-
| [[TextDisplay.row]] || get or set the cursor row, 0-25 (used on subsequent [[TextDisplay.print]])
|-
| [[TextDisplay.inverse]] || when true, subsequent printing swaps text and background color
|-
| [[TextDisplay.delimiter]] || get/set the extra character output after every [[TextDisplay.print]])
|-
| [[TextDisplay.cell]](''x'', ''y'') || get the character at the given column and row
|-
| [[TextDisplay.setCell]] ''x'', ''y'', k || store character ''k'' into the given column and row
|-
| [[TextDisplay.cellColor]](''x'', ''y'') || get the text color at the given column and row
|-
| [[TextDisplay.setCellColor]] ''x'', ''y'', c || set the text color at the given column and row to ''c''
|-
| [[TextDisplay.cellBackColor]](''x'', ''y'') || get the background color at the given column and row
|-
| [[TextDisplay.setCellBackColor]] ''x'', ''y'', c || set the background color at the given column and row to ''c''
|-
| [[TextDisplay.print]] ''s'' || print string ''s'' (followed by the [[TextDisplay.delimiter|delimiter]])
|}

[[Category:Mini Micro]]

PixelDisplay

2021-01-14T18:00:35Z

Mantic: Added mini micro category so it shows up in the mini micro pages list.

The <c>PixelDisplay</c> class in [[Mini Micro]] is a display type that represents a rectangular pixel buffer, with methods to efficiently draw lines, shapes, images, and text.

By default, [[display]] 5 is configured as a pixel display, and is in fact the pixel display to which the [[gfx]] global refers (unless you change it). But you can make any display layer a pixel display by setting its [[Display.mode|mode]] to <c>displayMode.pixel</c>.

== Methods and Properties ==

{| class="wikitable"
|-
! Method or Property !! Purpose
|-
| [[PixelDisplay.color]] || get or set the default drawing color, used when color is not otherwise specified
|-
| [[PixelDisplay.width]] || number of columns in the the pixel buffer
|-
| [[PixelDisplay.height]] || number of rows in the the pixel buffer
|-
| [[PixelDisplay.scale]] || scaling factor used to magnify (or shrink) the pixel display on screen
|-
| [[PixelDisplay.clear]] ''[color]'', ''[width]'', ''[height]'' || clear/reset the pixel buffer
|-
| [[PixelDisplay.pixel]] ''x '', ''y'' || get the color of a particular pixel
|-
| [[PixelDisplay.setPixel]] ''x'', ''y'', ''[color]'' || set the color of a particular pixel
|-
| [[PixelDisplay.scrollX]] || get or set a horizontal shift applied to the entire display
|-
| [[PixelDisplay.scrollY]] || get or set a vertical shift applied to the entire display
|-
| [[PixelDisplay.line]] ''x1'', ''y1'', ''x2'', ''y2'', ''[color]'', ''[penSize]'' || draw a line
|-
| [[PixelDisplay.drawRect]] ''left'', ''bottom'', ''width'', ''height'', ''[color]'', ''[penSize]'' || draw a rectangle outline
|-
| [[PixelDisplay.fillRect]] ''left'', ''bottom'', ''width'', ''height'', ''[color]'' || draw a filled rectangle
|-
| [[PixelDisplay.drawEllipse]] ''left'', ''bottom'', ''width'', ''height'', ''[color]'', ''[penSize]'' || draw an ellipse outline
|-
| [[PixelDisplay.fillEllipse]] ''left'', ''bottom'', ''width'', ''height'', ''[color]'' || draw a filled ellipse
|-
| [[PixelDisplay.drawPoly]] ''points'', ''[color]'', ''[penSize]'' || draw a polygon outline
|-
| [[PixelDisplay.fillPoly]] ''left'', ''bottom'', ''width'', ''height'', ''[color]'' || draw a filled polygon
|-
| [[PixelDisplay.drawImage]] ''img'', ''left'', ''bottom'', ''[width]'', ''[height]'', ''[srcLeft]'', ''[srcBottom]'', ''[srcWidth]'', ''[srcHeight]'' || draw an [[Image]] (or portion thereof)
|-
| [[PixelDisplay.getImage]](''left'', ''bottom'', ''width'', ''height'') || get a portion of the pixel buffer as an [[Image]]
|-
| [[PixelDisplay.print]] ''str'', ''x'', ''y'', ''[color]'', ''[font]'' || draw a string
|}

[[Category:Mini Micro]]