0002 - Mapping¶

Most treasure maps cannot be traded normally, like an item (except for any gilded scroll case). For the ones that can, please check Items. Instead, a user would have to open a map scroll, then invite whoever they would like to invite into the map, or if a user wants to join a map, then they would have to request an invite.

Map instances¶

GNAWEX must have a record of all treasure maps, which we may refer to as such. If a user opens it, then it's an instance of the treasure map, or a treasure map instance. The instance must contain all the relevant details needed to distinguish it from other instances.

An instance's MH map ID must be unique. One can get their MH map ID under Active Maps -> Map they want to check -> Hunters -> Share. It looks something like this: https://www.mousehuntgame.com/tm.php?map_id=000000 wherein the sequence of 0s is the MH map ID.

So, an instance must have the ff details:

Once delisted, they must not be able to reverse this action.

Restrictions¶

There are two types of maps: an event map, and a normal map. Since a user may have one active instance per type, the restriction follows as well. A user must only have at most two map instances, if one of it is a normal instance, and the other is an event instance. They must not be able to have more than one active normal instance, for example.

If the user wishes to create another instance, they must delist their active instance first.

Instance roles¶

In an instance, the maptain must specify what role(s) they would like to invite. The number of roles that they may invite depends on the number of available slots that the map has.

These roles that the maptain may look for have specific duties to fulfill (the who invites). Others may also look for maps that have these roles available for invite (the joiner). The roles are best described by Aardwolf's mapping 103 guide. In short: a user may invite in at least one role, or join as only one role.

These are the supported roles that may be invited to an instance:

Role listings¶

A role listing describes a user's intent to invite others to/participate in a map instance. Hence, these can be categorized into two types: an invite listing, and a join request listing.

Depending on the role, certain columns may be set; for others, maybe not. But here's what all role listings must have recorded:

Roles, in-depth¶

Maptain¶

Giving away a maptain role means that you're going to give the entirety of an already-opened map. A user must not be able to sell a maptain alongside other roles because there are no other slots/roles that can be added. A user also must not be able to pick the maptain role to both invite/join for scroll cases that can be traded. But their dusted counterparts are eligible.

Sniper/Looter¶

Sniper/looter roles are considered temporary roles in a map instance because they do not stick around when it's complete (for the map chest). GNAWEX must also keep a record of all possible mice for the snipers and maptains to select.

For the maptain:

For the sniper:

The sniper must not need to specify the instance, nor the map because all they're concerned with is dealing with the mouse/loot, nothing else.

Here's what the flow looks like:

1. Maptain creates an invite listing with one available role: a sniper role and chooses the mouse/item to snipe/loot
2. Match happens
3. Sniper/looter clicks link and requests to join
4. Maptain accepts invite
5. Sniper/looter does their job & leaves
6. Maptain and sniper/looter mark the transaction as complete
7. GNAWEX frees up one extra role for the instance

With this, the maptain may look for a new role to invite.

Helpers¶

Since helpers are expected help out with the map, no payment is involved.

For the maptain:

For the helper:

The helper must specify what kind of map they would like to help out with, but must not need to specify a particular instance because the matching is done by GNAWEX.

Leechers¶

Leechers are not expected to help out with the map, and they need to pay the maptain to join.

For the maptain:

For the leecher:

Dusters¶

Dusters are like leechers, but must dust the map. So they either get charged much less, or even get paid. If the maptain will pay the duster, then they must not set how much they [the maptain] will get paid.

For the maptain:

For the leecher:

Closers¶

Closers are like leechers. Except they must get the LM/LL, and they must pay the maptain to join. But a discount is usually provided.

For the maptain:

For the closer:

Role restrictions¶

Here are the current role restrictions:

Create a join request listing¶

A user may create a join request listing but must only be allowed to pick one role to join as. If they want to be two roles for the same kind of map (e.g Nice List), then they must create two join request listings. If their listing gets matched with another, all of their other join request listings will be temporarily delisted until the transaction is complete.

They may also choose their preferred LM, or select a group of mice that they would like to have as the LM. If they do not choose a LM, then this means anything goes.

Create an invite listing¶

An invite listing means the maptain is looking to invite others to the map to fulfill a single role. A maptain may have multiple role invite listnings if they need to look for multiple roles.

Updating a listing¶

A role listing may be updated but restrictions apply. Generally speaking, a listing must not be updated if it has already concluded.

Invite listing¶

A maptain may add new roles, or remove unfilled roles. They must not remove roles that are involved in a PENDING or COMPLETED transaction.

Concluding a listing¶

A role listing must be considered concluded if it was CANCELLED, or COMPLETED.

Transactions¶

Status¶

• PENDING - If the joiner is still fulfilling their duties/waiting for the map to complete/close. This must 'hold' the role.
• COMPLETED - When the joiner has fulfilled their duties/the map is completed. This must 'indefinitely' hold the role.
• CANCELLED - If both the maptain and the joiner are in mutual agreement, and decide to back off of their deal. Both need to mark it as CANCELLED otherwise it will not be marked as such. Cancelling must release the role back.

FAQ¶

WIP