code/__DEFINES/rust_g.dm

/proc/rustg_get_version	Gets the version of rust_g
rustg_setup_acreplace	Sets up the Aho-Corasick automaton with its default options.
rustg_setup_acreplace_with_options	Sets up the Aho-Corasick automaton using supplied options.
rustg_acreplace	Run the specified replacement engine with the provided haystack text to replace, returning replaced text.
rustg_acreplace_with_replacements	Run the specified replacement engine with the provided haystack text to replace, returning replaced text.
rustg_cnoise_generate	This proc generates a cellular automata noise grid which can be used in procedural generation methods.
rustg_dbp_generate	This proc generates a grid of perlin-like noise
rustg_dmi_icon_states	input: must be a path, not an /icon; you have to do your own handling if it is one, as icon objects can't be directly passed to rustg.
rustg_git_revparse	Returns the git hash of the given revision, ex. "HEAD".
/proc/rustg_git_commit_date	Returns the date of the given revision using the provided format. Defaults to returning %F which is YYYY-MM-DD.
/proc/rustg_git_commit_date_head	Returns the formatted datetime string of HEAD using the provided format. Defaults to returning %F which is YYYY-MM-DD. This is different to rustg_git_commit_date because it only needs the logs directory.
rustg_encode_base64	Encode a given string into base64
rustg_decode_base64	Decode a given base64 string
rustg_iconforge_generate	Generates a spritesheet at: [file_path][spritesheet_name]_[size_id].png The resulting spritesheet arranges icons in a random order, with the position being denoted in the "sprites" return value. All icons have the same y coordinate, and their x coordinate is equal to `icon_width * position`.
rustg_iconforge_generate_async	Returns a job_id for use with rustg_iconforge_check()
rustg_iconforge_check	Returns the status of an async job_id, or its result if it is completed. See RUSTG_JOB DEFINEs.
rustg_iconforge_cleanup	Clears all cached DMIs and images, freeing up memory. This should be used after spritesheets are done being generated.
rustg_iconforge_cache_valid	Takes in a set of hashes, generate inputs, and DMI filepaths, and compares them to determine cache validity. input_hash: xxh64 hash of "sprites" from the cache. dmi_hashes: xxh64 hashes of the DMIs in a spritesheet, given by `rustg_iconforge_generate` with `hash_icons` enabled. From the cache. sprites: The new input that will be passed to rustg_iconforge_generate(). Returns a CacheResult with the following structure: list( "result": "1" (if cache is valid) or "0" (if cache is invalid) "fail_reason": "" (emtpy string if valid, otherwise a string containing the invalidation reason or an error with ERROR: prefixed.) ) In the case of an unrecoverable panic from within Rust, this function ONLY returns a string containing the error.
rustg_iconforge_cache_valid_async	Returns a job_id for use with rustg_iconforge_check()
rustg_noise_poisson_map	Generates a 2D poisson disk distribution ('blue noise'), which is relatively uniform.
rustg_register_nodes_astar	Register a list of nodes into a rust library. This list of nodes must have been serialized in a json. Node {// Index of this node in the list of nodes unique_id: usize, // Position of the node in byond x: usize, y: usize, z: usize, // Indexes of nodes connected to this one connected_nodes_id: Vec} It is important that the node with the unique_id 0 is the first in the json, unique_id 1 right after that, etc. It is also important that all unique ids follow. {0, 1, 2, 4} is not a correct list and the registering will fail Nodes should not link across z levels. A node cannot link twice to the same node and shouldn't link itself either
rustg_add_node_astar	Add a new node to the static list of nodes. Same rule as registering_nodes applies. This node unique_id must be equal to the current length of the static list of nodes
rustg_remove_node_astar	Remove every link to the node with unique_id. Replace that node by null
rustg_generate_path_astar	Compute the shortest path between start_node and goal_node using A*. Heuristic used is simple geometric distance
rustg_redis_connect_rq	Connects to a given redis server.
/proc/rustg_redis_disconnect_rq	Disconnects from a previously connected redis server
rustg_redis_lpush	https://redis.io/commands/lpush/
rustg_redis_lrange	https://redis.io/commands/lrange/
rustg_redis_lpop	https://redis.io/commands/lpop/
/proc/rustg_unix_timestamp	Returns the timestamp as a string
rustg_worley_generate	This proc generates a noise grid using worley noise algorithm

Define Details

#define
rustg_acreplace
(key, text)

Run the specified replacement engine with the provided haystack text to replace, returning replaced text.

Arguments:

key - The key for the automaton
text - Text to run replacements on

#define
rustg_acreplace_with_replacements
(key, text, replacements)

Run the specified replacement engine with the provided haystack text to replace, returning replaced text.

Arguments:

key - The key for the automaton
text - Text to run replacements on
replacements - Replacements for this call. Must be the same length as the set-up patterns

#define
rustg_add_node_astar
(json)

Add a new node to the static list of nodes. Same rule as registering_nodes applies. This node unique_id must be equal to the current length of the static list of nodes

#define
rustg_cnoise_generate
(percentage, smoothing_iterations, birth_limit, death_limit, width, height)

This proc generates a cellular automata noise grid which can be used in procedural generation methods.

Returns a single string that goes row by row, with values of 1 representing an alive cell, and a value of 0 representing a dead cell.

Arguments:

percentage: The chance of a turf starting closed
smoothing_iterations: The amount of iterations the cellular automata simulates before returning the results
birth_limit: If the number of neighboring cells is higher than this amount, a cell is born
death_limit: If the number of neighboring cells is lower than this amount, a cell dies
width: The width of the grid.
height: The height of the grid.

#define
rustg_dbp_generate
(seed, accuracy, stamp_size, world_size, lower_range, upper_range)

This proc generates a grid of perlin-like noise

Returns a single string that goes row by row, with values of 1 representing an turned on cell, and a value of 0 representing a turned off cell.

Arguments:

seed: seed for the function
accuracy: how close this is to the original perlin noise, as accuracy approaches infinity, the noise becomes more and more perlin-like
stamp_size: Size of a singular stamp used by the algorithm, think of this as the same stuff as frequency in perlin noise
world_size: size of the returned grid.
lower_range: lower bound of values selected for. (inclusive)
upper_range: upper bound of values selected for. (exclusive)

#define
rustg_decode_base64
(str)

Decode a given base64 string

#define
rustg_dmi_icon_states
(fname)

input: must be a path, not an /icon; you have to do your own handling if it is one, as icon objects can't be directly passed to rustg.

output: json_encode'd list. json_decode to get a flat list with icon states in the order they're in inside the .dmi

#define
rustg_encode_base64
(str)

Encode a given string into base64

#define
rustg_generate_path_astar
(start_node_id, goal_node_id)

Compute the shortest path between start_node and goal_node using A*. Heuristic used is simple geometric distance

#define
rustg_git_revparse
(rev)

Returns the git hash of the given revision, ex. "HEAD".

#define
rustg_iconforge_cache_valid
(input_hash, dmi_hashes, sprites)

Takes in a set of hashes, generate inputs, and DMI filepaths, and compares them to determine cache validity. input_hash: xxh64 hash of "sprites" from the cache. dmi_hashes: xxh64 hashes of the DMIs in a spritesheet, given by rustg_iconforge_generate with hash_icons enabled. From the cache. sprites: The new input that will be passed to rustg_iconforge_generate(). Returns a CacheResult with the following structure: list( "result": "1" (if cache is valid) or "0" (if cache is invalid) "fail_reason": "" (emtpy string if valid, otherwise a string containing the invalidation reason or an error with ERROR: prefixed.) ) In the case of an unrecoverable panic from within Rust, this function ONLY returns a string containing the error.

#define
rustg_iconforge_cache_valid_async
(input_hash, dmi_hashes, sprites)

Returns a job_id for use with rustg_iconforge_check()

#define
rustg_iconforge_check
(job_id)

Returns the status of an async job_id, or its result if it is completed. See RUSTG_JOB DEFINEs.

#define
rustg_iconforge_cleanup

Clears all cached DMIs and images, freeing up memory. This should be used after spritesheets are done being generated.

#define
rustg_iconforge_generate
(file_path, spritesheet_name, sprites, hash_icons)

Generates a spritesheet at: [file_path][spritesheet_name]_[size_id].png The resulting spritesheet arranges icons in a random order, with the position being denoted in the "sprites" return value. All icons have the same y coordinate, and their x coordinate is equal to icon_width * position.

hash_icons is a boolean (0 or 1), and determines if the generator will spend time creating hashes for the output field dmi_hashes. These hashes can be heplful for 'smart' caching (see rustg_iconforge_cache_valid), but require extra computation.

Spritesheet will contain all sprites listed within "sprites". "sprites" format: list( "sprite_name" = list(// <--- this list is a [SPRITE_OBJECT] icon_file = 'icons/path_to/an_icon.dmi', icon_state = "some_icon_state", dir = SOUTH, frame = 1, transform = list([TRANSFORM_OBJECT], ...) ), ..., ) TRANSFORM_OBJECT format: list("type" = RUSTG_ICONFORGE_BLEND_COLOR, "color" = "#ff0000", "blend_mode" = ICON_MULTIPLY) list("type" = RUSTG_ICONFORGE_BLEND_ICON, "icon" = [SPRITE_OBJECT], "blend_mode" = ICON_OVERLAY) list("type" = RUSTG_ICONFORGE_SCALE, "width" = 32, "height" = 32) list("type" = RUSTG_ICONFORGE_CROP, "x1" = 1, "y1" = 1, "x2" = 32, "y2" = 32) // (BYOND icons index from 1,1 to the upper bound, inclusive)

Returns a SpritesheetResult as JSON, containing fields: list( "sizes" = list("32x32", "64x64", ...), "sprites" = list("sprite_name" = list("size_id" = "32x32", "position" = 0), ...), "dmi_hashes" = list("icons/path_to/an_icon.dmi" = "d6325c5b4304fb03", ...), "sprites_hash" = "a2015e5ff403fb5c", // This is the xxh64 hash of the INPUT field "sprites". "error" = "[A string, empty if there were no errors.]" ) In the case of an unrecoverable panic from within Rust, this function ONLY returns a string containing the error.

#define
rustg_iconforge_generate_async
(file_path, spritesheet_name, sprites, hash_icons)

Returns a job_id for use with rustg_iconforge_check()

#define
rustg_noise_poisson_map
(seed, width, length, radius)

Generates a 2D poisson disk distribution ('blue noise'), which is relatively uniform.

params: seed: str width: int, width of the noisemap (see world.maxx) length: int, height of the noisemap (see world.maxy) radius: int, distance between points on the noisemap

returns: a width*length length string of 1s and 0s representing a 2D poisson sample collapsed into a 1D string

#define
rustg_redis_connect_rq
(addr)

Connects to a given redis server.

Arguments:

addr - The address of the server, for example "redis://127.0.0.1/"

#define
rustg_redis_lpop
(key, count)

https://redis.io/commands/lpop/

Arguments

key (string) - The key to use
count (string|null) - The amount to pop off the list, pass null to omit (thus just 1)

Note: count was added in Redis version 6.2.0

#define
rustg_redis_lpush
(key, elements)

https://redis.io/commands/lpush/

Arguments

key (string) - The key to use
elements (list) - The elements to push, use a list even if there's only one element.

#define
rustg_redis_lrange
(key, start, stop)

https://redis.io/commands/lrange/

Arguments

key (string) - The key to use
start (string) - The zero-based index to start retrieving at
stop (string) - The zero-based index to stop retrieving at (inclusive)

#define
rustg_register_nodes_astar
(json)

Register a list of nodes into a rust library. This list of nodes must have been serialized in a json. Node {// Index of this node in the list of nodes unique_id: usize, // Position of the node in byond x: usize, y: usize, z: usize, // Indexes of nodes connected to this one connected_nodes_id: Vec} It is important that the node with the unique_id 0 is the first in the json, unique_id 1 right after that, etc. It is also important that all unique ids follow. {0, 1, 2, 4} is not a correct list and the registering will fail Nodes should not link across z levels. A node cannot link twice to the same node and shouldn't link itself either

#define
rustg_remove_node_astar
(unique_id)

Remove every link to the node with unique_id. Replace that node by null

#define
rustg_setup_acreplace
(key, patterns, replacements)

Sets up the Aho-Corasick automaton with its default options.

The search patterns list and the replacements must be of the same length when replace is run, but an empty replacements list is allowed if replacements are supplied with the replace call Arguments:

key - The key for the automaton, to be used with subsequent rustg_acreplace/rustg_acreplace_with_replacements calls
patterns - A non-associative list of strings to search for
replacements - Default replacements for this automaton, used with rustg_acreplace

#define
rustg_setup_acreplace_with_options
(key, options, patterns, replacements)

Sets up the Aho-Corasick automaton using supplied options.

The search patterns list and the replacements must be of the same length when replace is run, but an empty replacements list is allowed if replacements are supplied with the replace call Arguments:

key - The key for the automaton, to be used with subsequent rustg_acreplace/rustg_acreplace_with_replacements calls
options - An associative list like list("anchored" = 0, "ascii_case_insensitive" = 0, "match_kind" = "Standard"). The values shown on the example are the defaults, and default values may be omitted. See the identically named methods at https://docs.rs/aho-corasick/latest/aho_corasick/struct.AhoCorasickBuilder.html to see what the options do.
patterns - A non-associative list of strings to search for
replacements - Default replacements for this automaton, used with rustg_acreplace

#define
rustg_worley_generate
(region_size, threshold, node_per_region_chance, size, node_min, node_max)

This proc generates a noise grid using worley noise algorithm

Returns a single string that goes row by row, with values of 1 representing an alive cell, and a value of 0 representing a dead cell.

Arguments:

region_size: The size of regions
threshold: the value that determines wether a cell is dead or alive
node_per_region_chance: chance of a node existiing in a region
size: size of the returned grid
node_min: minimum amount of nodes in a region (after the node_per_region_chance is applied)
node_max: maximum amount of nodes in a region

code/__DEFINES/rust_g.dm

Define Details

#define rustg_acreplace(key, text)

#define rustg_acreplace_with_replacements(key, text, replacements)

#define rustg_add_node_astar(json)

#define rustg_cnoise_generate(percentage, smoothing_iterations, birth_limit, death_limit, width, height)

#define rustg_dbp_generate(seed, accuracy, stamp_size, world_size, lower_range, upper_range)

#define rustg_decode_base64(str)

#define rustg_dmi_icon_states(fname)

#define rustg_encode_base64(str)

#define rustg_generate_path_astar(start_node_id, goal_node_id)

#define rustg_git_revparse(rev)

#define rustg_iconforge_cache_valid(input_hash, dmi_hashes, sprites)

#define rustg_iconforge_cache_valid_async(input_hash, dmi_hashes, sprites)

#define rustg_iconforge_check(job_id)

#define rustg_iconforge_cleanup

#define rustg_iconforge_generate(file_path, spritesheet_name, sprites, hash_icons)

#define rustg_iconforge_generate_async(file_path, spritesheet_name, sprites, hash_icons)

#define rustg_noise_poisson_map(seed, width, length, radius)

#define rustg_redis_connect_rq(addr)

#define rustg_redis_lpop(key, count)

#define rustg_redis_lpush(key, elements)

#define rustg_redis_lrange(key, start, stop)

#define rustg_register_nodes_astar(json)

#define rustg_remove_node_astar(unique_id)

#define rustg_setup_acreplace(key, patterns, replacements)

#define rustg_setup_acreplace_with_options(key, options, patterns, replacements)

#define rustg_worley_generate(region_size, threshold, node_per_region_chance, size, node_min, node_max)

#define
rustg_acreplace
(key, text)

#define
rustg_acreplace_with_replacements
(key, text, replacements)

#define
rustg_add_node_astar
(json)

#define
rustg_cnoise_generate
(percentage, smoothing_iterations, birth_limit, death_limit, width, height)

#define
rustg_dbp_generate
(seed, accuracy, stamp_size, world_size, lower_range, upper_range)

#define
rustg_decode_base64
(str)

#define
rustg_dmi_icon_states
(fname)

#define
rustg_encode_base64
(str)

#define
rustg_generate_path_astar
(start_node_id, goal_node_id)

#define
rustg_git_revparse
(rev)

#define
rustg_iconforge_cache_valid
(input_hash, dmi_hashes, sprites)

#define
rustg_iconforge_cache_valid_async
(input_hash, dmi_hashes, sprites)

#define
rustg_iconforge_check
(job_id)

#define
rustg_iconforge_cleanup

#define
rustg_iconforge_generate
(file_path, spritesheet_name, sprites, hash_icons)

#define
rustg_iconforge_generate_async
(file_path, spritesheet_name, sprites, hash_icons)

#define
rustg_noise_poisson_map
(seed, width, length, radius)

#define
rustg_redis_connect_rq
(addr)

#define
rustg_redis_lpop
(key, count)

#define
rustg_redis_lpush
(key, elements)

#define
rustg_redis_lrange
(key, start, stop)

#define
rustg_register_nodes_astar
(json)

#define
rustg_remove_node_astar
(unique_id)

#define
rustg_setup_acreplace
(key, patterns, replacements)

#define
rustg_setup_acreplace_with_options
(key, options, patterns, replacements)

#define
rustg_worley_generate
(region_size, threshold, node_per_region_chance, size, node_min, node_max)