Downloads
Download the Kirandur Demo Client now!
Yes, it really is here, the Kirandur live demo client! Download this client now to get ready for Kirandur's demo, launching on Saturday August 20 at 12 PM Eastern. Paying members of the Patreon will get access to it 48 hours earlier.
Read A quick Start Guide for the most important commands
Or, because the download is slow, feel free to check out the full game documentation below. A copy of this file is also available as part of the download.
Kirandur Client Documentation
The Kuloren Players
So, you've gotten your hands on the Kirandur client. You've probably already opened it up and began checking out the various screens. We have tried to ensure that the most essential and common features of the client are intuitive to pick up and use, but we've included a lot of other UX benefits that are less obvious. This documentation will try to cover everything, and it's even heading-indexed for easy navigation. What more could you ask for? The actual information, I suppose?
First Load
Once you press enter on kirandur.exe, the client will launch. You will hear the TKP logo and then the game will load up.
JAWS
If you're using JAWS, part of the load sequence includes checking for a Kirandur.jkm (JAWS keymap) file, and if it's not found, installing it to any JAWS user settings folders you have. Without the keymap, JAWS will intercept many Kirandur commands, causing you to have a bad time playing.
Language
Language selection is the next screen. You can select your language here; the only available one is English right now. If you browse the Kirandur folder where you extracted the client, you will see a localization folder, with a En folder inside. The .ftl files contain the English language translation for the client. If you want to translate the client, create a folder at the same level as En with your language code and copy in all the files. Then start changing all the items on the right of the = signs to the new language.
If you want to work with us to translate the game, we'd be interested in starting a dialogue with you about that. The server also has .ftl files that allow a translator to change the language of all the text of the game content. Translating the actual game content is a far longer process than translating the client, and TKP would have to supply you with the files. And it goes without saying that unreleased content needs to be kept confidential. After all of those warnings you are still interested in translating, reach out to a staff member either on the server if it's up, or via the TKP discord.
Keymap
Kirandur ships with two default keystroke presets. Most of the commands are the same, but if you are more familiar with browsing channel buffers in mud client soundpacks, choose the muds keymap. This maps your buffer navigation commands to alt+the arrow keys, home, end, page up and page down. If you are familiar with Mist World, you can instead use page up and down to browser buffers, add ctrl to switch buffers, and shift to jump to the top or bottom. Add alt+shift to rearrange buffer order.
Note: these keystrokes can be modified from the settings if you don't like them. We may add other keystroke presets if they are popular.
Main Screen
You are now in the main screen, which is the entry point for the game. Click log in to get started playing. The log in option will either log you in if you have logged in before on this PC, or will open your browser to log in to your TKP account. The TKP account is an account that lets you access all online TKP products with a single sign-on. Change options lets you adjust the game settings, and quit will close the game right away.
Quick Start
You probably started reading this documentation because you jumped right into the program then got confused, and you want to get back to playing. Here are the 10 most important things you need to know to get started, after you've finished making your account. Come back and read up more on specific topics later once you've checked out more about the game.
- Your account: You can have up to 5 characters in your account. This screen works like a standard dialog box where you can tab and shift tab around.
- What race / class / origin should I choose? The origins currently do not do anything, but in the final game they will grant you small bonuses that won't have much bearing on how you play. Classes determine what abilities you get, and your newbie tutorial experience.
- How do I move around? Movement is done with the ASDW keys.
- What are all those dings and womp sounds? These are the sonar which lets you know if there is open space, walls, or doors near you. Your screen reader will read out the information as well, but you might be interrupting it by moving. To do a readout of the sonar for where you are right now, press q. You can disable the automatic speech for the sonar in the hearing options screen, by pressing f5 from within the game.
- How do I chat and review messages? You can use alt+1 through 0 to review the last 10 mesages you have seen, which includes both tutorial messages and chats from other players. Press \ to send a message to the currently focused buffer. You can switch buffers with alt+left and right arrow keys on the muds keymap, or home and end on the Mist World keymap.
- How do I view my character sheet? Press tab to open the character menu where you can view and set many things about your current character. You can assign stat points, view abilities and manage your inventory, among other things.
- What do the arrow keys do? The arrow keys access your hotbar, which lets you quickly activate abilities, use consumable items, or equip armor and weapons. Press left and right arrows to switch categories, up and down to move between category items, and space to activate the selected item. Press shift+space to examine the selected item which usually describes what it does, and in the case of equipment and abilities, reads the stats as well.
- How do I look around? Press k, l, o, and; (semicolon) to track in that direction. These keys mirror the ASDW for movement, so pressing o will target things to the north of you. Once you target something, press p to track its location with a ping. Press p again to stop tracking it. Targeting something will try to aim any ability you use at it. If you are tracking something and hear the ping, you can press = to see how far it is from you, and how much health it has if it's alive.
- How do I defend myself? If someone attacks you first, press the ' key to try to target it. The ' key will alert you if you can't see the target, which may be the case if it is around a corner, or behind a door or wall. If targeting was successful, you can start firing abilities at the target to neutralize it.
- How do I interact with things? Get close to them, then press f. This lets you do things like loot containers, talk to people, or open and close doors. Press shift+f to look at things, which will often have descriptions for you to read. Looking has a much farther range than interacting.
Navigating screens
We have attempted to replicate all the best features of navigating user interfaces with the keyboard. You can tab and shift+tab between dialog controls and press escape to try and back out. Many controls have access keys which you can use to jump to them from anywhere in the dialog. And in the case of a button or checkbox, pressing the access key will activate the button or checkbox. Here's a quick breakdown of the most common controls you'll see. Even if you are familiar with Windows controls, read this to learn about more obscure commands that Windows does not have.
- Button: Buttons are pretty simple and when you activate one, the action on the button label will happen. Press space to activate buttons.
- Text fields: text fields store text.
- Some text fields are read only, meaning you can read but not edit the text.
- Some text fields are multi-line, meaning that you can enter multiple lines of text into the field by pressing shift+enter to insert the line break.
- Text fields support standard text reading and movement keys such as left and right arrows to move by character, ctrl+left and right to move by word, up and down to move by line, and shift with any of those commands to select in that direction instead of just moving. Windows clipboard commands (ctrl+x, c, and v for cut, copy and paste) are also supported.
- Press f2 to turn character echo on or off. It defaults to on. *Some text fields only support certain characters, such as numbers or lowercase letters but not capital ones.
- Others have a maximum length setting so you cannot enter more characters than the length.
- Text fields support basic text search functions by pressing ctrl+f while in the text field, typing a search term and pressing enter. This will move your cursor to the next occurrence of the search term if it's there. Press f3 to move forward looking for the next occurrence, or shift+f3 to search backward.
- Lists: Lists are a vertical list of options. You select from lists with the up and down arrows. Move to the first item with home, the last item with end, or scroll up or down by 10 items with page up and down.
- Many list items can be activated by pressing enter once the item is selected. For example, the main screen presents its options in a list and you press enter to activate the item.
- Lists support first letter navigation.
- Lists support ctrl+f to search, f3 to search forward or shift+f3 to search backward. The search will select each list item that contains the term you searched for in order.
- Some lists support multiple selections. When this happens, press space on an item to mark it as selected. Press ctrl+a to select everything, and ctrl+d to deselect everything.
- Sliders: sliders allow you to adjust a number value. You can use the arrow keys to adjust the slider in small increments, the page up and down keys to adjust in larger increments, and home or end to set the slider to the maximum or minimum value. Each slider has a varying interval of movement when using the arrow keys and when using page up and down.
- Check boxes: press spacebar on a checkbox to check or uncheck it.
- Tree view: Tree views show hierarchies of items, with larger items nearer the left side of the tree and smaller items contained inside them. Those sub-items may contain even smaller items, and this can go on for several levels of containment. When you navigate tree views, you can open and close the containing items. If the containing item is collapsed, any contents inside it are hidden and can't be navigated to unless the larger item is expanded. Expand a collapsed item with the right arrow key, and collapse an expanded item to hide its contents with the left arrow key. As you switch levels, you will hear the new level you are at. Level 0 contains the largest items, and higher level numbers represent smaller sub-items. The player atlas, found by pressing tab from within the main game, and then choosing atlas, is a good example of tree view navigation.
- Tree views support first letter navigation, but only among visible items. Items may have sub-items inside that match the letter you entered, but will be skipped if they are not visible by expanding all of the larger sub-items containing them first.
- Tree views support searching with ctrl+f, f3 and shift+f3 similar to lists. However, the search feature will search all the items, even the collapsed ones. If it finds an item, it will force all of its containers to expand when the search feature navigates to it.
Game Options
The game options screen, accessible by selecting change options from the main screen, contains the client options. The settings categories open dialogs that contain settings that you can adjust. The back button will cause the changes to be saved temporarily and will be kept until you exit the client. To save them permanently to disk, you must press enter on save options permanently. You can also access the game options screen by pressing f5 while connected to the game so you don't have to log out.
- Language: this lets you change your language. This is not available when pressing f5, but is available from the main screen, so you will have to log out and back in for it.
- Navigation: Here you can adjust:
- The speed of the pathfinding beacon, which is used with the atlas system to help you find things. You can access the atlas system by pressing tab for your character sheet, and then pressing enter on atlas. You can press enter on any atlas item that says that pathfinding is available. Pathfinding availability is generally restricted to the current map you are on. In the atlas item view, press tab to the find path button to start the pathfinding beacon, then just follow the beacon, which will guide you to the point of interest. The beacon stops at direction changes, or if a straight path is 20 or more units long, it will stop after traveling 20 units down the path until you catch up with it. If you somehow lose the beacon, just track the atlas item again and it will return to you and recalculate the route.
- Block graphic display: for low vision players, the game can show a map of colored squares on your screen. Your character is the circle in the middle, walls are solid black and open space is solid white. Because your character automatically climbs slopes, there is no depth representation in the graphic display. The graphic display only shows a 12 tile radius around your character, and it won't reveal anything you can' see such as the terrain around a corner or a door frame. The graphic display goes through screen curtain so be aware of this.
- New Target Notification: If the new target announcements telling you about NPCs that come in to view are annoying, you can turn them off here, or make it so they only play a sound at their position.
- Sound volumes: Use this option to adjust the volumes of various kinds of sounds. Some of the sound categories will not make sense to you at first, but they all have a function.
- Hearing: Here you can adjust audio system settings.
- Audio system settings (stereo and occlusion): These are all a matter of personal preference, so feel free to experiment with adjusting the options here. One thing to note is that the options only affect sounds that play in the future, not the ones playing right now. For example, if you adjust the occlusion settings, a sound source that is currently playing looped will not update. You will need to log out and back in to force that source to play with the new settings. The stereo blend settings determine how sounds that are close to you sound; you can either have them play fully in hrtf, which will make them sound mono but position them better, or with progressively wider stereo settings, but that also sacrifice some of the authenticity of the sound.
- Speak sonar output: useful for hard of hearing people or beginning players who want to get speech feedback about nearby walls and doors in addition to the sonar sounds.
- Lower sound volumes in the background: This lets you selectively duck sound categories when yous witch away from the window. Very useful if you like the game music and ambience but want to lower them when working on something else. (Yes, we think it sounds great too!)
- Keybindings: here is where you can adjust the keystrokes for the game. expand a category, then expand an action such as move forward. You will see the key mapped to that action right now. Press enter to adjust it, then tab to the rebind button and activate that button. Then, press the new key you want. Then click the save button. Before you can close the keybindings screen, the client will check if there are any conflicts and let you know so they can be adjusted.
- Resource Bar: choose how verbose the audible resource bar is. The audible resource bar plays pitched sounds to represent your health, mana and stamina as they change throughout gameplay, and a different sound for when each is at maximum. Setting the threshold higher means the sounds will play less often.
Playing the game
Movement
Besides the ASDW keys to move, you have several other movement commands available. You can press shift+w to switch between walking and running. Walking is obviously slower than running, so there is not much point to doing this right now.
Your character automatically climbs and descends slopes, so you might see things going above or below you as you do this. You can check your coordinates with shift+q. Note that the third coordinate is your z coordinate, which in Kirandur represents your vertical height. Z 128 is ground level for most maps.
Targeting and tracking
Tutorials may have mentioned this to you, but you can filter your targets by type with the bracket keys. Note that when it mentions friendly, hostile, or neutral, that is how those targets feel toward you. You may not necessarily have a mutual feeling toward those targets, but as a player, you can attack just about anything except other players, and NPC civilians that should not be killed.
You can also try to track map objects such as doors or portals with alt+the targeting keys. Some map objects are intentionally unable to be targeted this way. To start navigation toward that object, pres alt+p. Press alt+shift+p to clear the map object tracking.
If you hear a message such as "All: 2 neutral, 1 civilian", you can filter your targeting further by pressing shift+bracket keys to switch between subcategories. In this case, you could use the shift+brackets to only show the neutrals or only show the civilian. This has no effect when viewing corpses or containers.
Press ' to target whatever has dealt damage to you last, as long as it is in view. This memory fades 30 seconds after the damage is dealt.
Pressing p will play a targeting beacon at the position of the entity you just targeted. Press p again to cancel the beacon. The beacon may stop if the tracked target goes out of view or dies. Press = to hear where and how far away the beacon is in relation to you, and the health percentage of the target if the target has health.
By default, the game announces targets as they come into view with a quick sound and a mesage to your screen reader. You can press shift+p to toggle whether you get sound, speech, or nothing for these announcements, but this is only temporary and will reset to the saved setting when Kirandur closes. You will probably turn this on while exploring new areas and turn it off for more familiar ones.
Hotbar and Abilities
You already know how to navigate around your hotbar. The game offers a quick way to bind up to 20 hotbar items to keys, which are called quickslots. The default keys for quickslots are 1-0, y u i, h j, and n through /. To assign a hotbar item to a quickslot, find the item in the hotbar, and press ctrl+the key you want to use for it. For example to bind an ability to the 1 key, find the ability in the hotbar, and press ctrl+1. Now, you can activate that ability from anywhere by pressing 1, and examine it with shift+1.
If you want to reasign a quickslot, just press ctrl+the activation key again, and it will instantly reassign.
Many abilities require you to first be in the ready for combat state to use them. If you use an ability and are not in the ready state, your first attempt to use it will ready you instead of using it, so you'll have to wait to be ready (this is about a second) and then try using the ability again. Pres the ` (key next to 1) to toggle between ready and unready. Currrently, this only affects how fast you regenerate your health, mana and stamina, but in the future, many NPCs will react suspiciously to you if you are in the ready state in their presence, as the ready state implies an aggressive mood to them.
Combat music will play as soon a you take or deal damage to an NPC, and will eventually fade back to the exploration music if no damage is taken or dealt for about 12 seconds.
Death
If you die, you are returned to the starting spot for your map. Right now, you have no permanent penalties, but have to regenerate all your resources from 0. Luckily, you are automatically unreadied when you die, so you can regenerate at maximum speed.
Channels and buffers
Communications in Kirandur are done via buffers. Our buffer system has two keymap options: the mist world keymap, and the muds keymap. If you are playing with muds, the keys are:
- Alt+up and down arrow: move up and down in the current buffer
- Alt + left and right arrow: switch buffers
- Alt+home and end: move to the top or bottom of the current buffer
- Ctrl+alt+left or right arrows: move to the first or last buffer
- Alt+page up and down: page up or down in the current buffer (default is 20 messages)
- Alt+shift+left and right arrows: reorder buffers
If you are playing with the Mist World keymap, the keys are:
- Page up and down: move up or down in the current buffer
- Home and end: switch buffers
- Ctrl+page up and down: move to the top or bottom of the current buffer
- Ctrl+home and end: move to the first or last buffer
- Shift+page up and down: page up or down in the current buffer (default is 20 messages)
- Alt+shift+Home and end: reorder buffers
Additionally, the following keys are applicable to both keymaps: * Alt+1 through 0: read the 10 most recent messages from any buffer. This lets you review new messages coming in without having to switch buffers. Press twice quickly to copy the message to the clipboard, 3 times quickly to switch to the buffer that that message came from. * alt+c: copy the currently selected buffer message to the clipboard * Alt+v: view the currently selected buffer message in a text box * \: send a message in the current buffer if you can. Some buffers can't be sent to, such as the tutorial buffer. If you get a direct message, pressing \ on a direct message will send a direct message to the sender. * ctrl+enter: open buffer settings for the current buffer. These let you set when the buffer automatically reads, so you can mute some buffers while they are not in the foreground. There are also some other settings, such as whether to show a relative time after each message, or if you want to disable logging for that buffer.
Also, remember to press tab for your character screen, and check out the communications interface. Here, you can do things like connect to other channels, mute players or block their direct messages.