Developer Primer - Revision history

Reden at 00:52, 19 October 2023

Reden — Thu, 19 Oct 2023 00:52:37 GMT

←Older revision		Revision as of 00:52, 19 October 2023
Line 2:		Line 2:

	Some of this material may be old hat for those who have past experience with command line interfaces, FTP, or coding. If you haven't, going through this material may take some time. Please be patient. If you remain active-minded, all of this will become far less mysterious the more you dev, I promise.		Some of this material may be old hat for those who have past experience with command line interfaces, FTP, or coding. If you haven't, going through this material may take some time. Please be patient. If you remain active-minded, all of this will become far less mysterious the more you dev, I promise.
		+
		+	==Onboarding==
		+	[2023 Oct 18 18:48] [OOC Merun] only problem i can forsee with this is i'd
		+	need to start my first project before i can "start" playing again... But then
		+	again that isn't a problem, it's just a waiting thing
		+	[2023 Oct 18 18:48] [OOC Starhound] ive also put probably dozens of hours into
		+	improving our development experience too
		+	[2023 Oct 18 18:48] [OOC Starhound] its still not perfect but we have good
		+	color and editor support
		+	[2023 Oct 18 18:49] [OOC Starhound] yes, you must complete the onboarding or
		+	step down to play again. there is no hard feelings & you're always welcome
		+	back
		+	[2023 Oct 18 18:49] [OOC Merun] Sorry it's been an age since i heard the term
		+	onboarding? What is that for lostsouls again?
		+	[2023 Oct 18 18:50] [OOC Starhound] 3 tasks, you make your dev room, you make
		+	an npc/item combo, you make an area. upon deployment of the area your
		+	onboarding is complete
		+	[2023 Oct 18 18:50] [OOC Starhound] essentially
		+	[2023 Oct 18 18:50] [OOC Starhound] we have docs on it all
		+	[2023 Oct 18 18:51] [OOC Starhound] i also tend to encourage people to
		+	collaborate so if we have multiple people still in onboarding they can take on
		+	a slightly bigger project or whatever and get 2 birds with one stone
		+	[2023 Oct 18 18:52] [OOC Starhound] once you finish onboarding you get to view
		+	affiliation code and can create affils, or basically whatever at that point.
		+	you just have to go through the standard content approval process (talking to
		+	a senior+ dev about it and getting an ok) and off you go
		+	[2023 Oct 18 18:53] [OOC Starhound] once you can be trusted to write stuff in
		+	line with the lib philosophy you dont have to even do that, just write it
		+	right.
		+	You won't be allowed to play the game "normally" before completing this process.

	==A Few Necessities==		==A Few Necessities==

Esmene: /* FTP Client and Code Editor */

Esmene — Mon, 05 Dec 2022 16:26:09 GMT

FTP Client and Code Editor

←Older revision		Revision as of 16:26, 5 December 2022
Line 51:		Line 51:
	There is also the useful "show administrative commands" file. Each of those commands has a help file for it. Don't worry if you don't understand what many of them do; just skim through it occasionally, and as you develop more and more, you'll learn the various commands.		There is also the useful "show administrative commands" file. Each of those commands has a help file for it. Don't worry if you don't understand what many of them do; just skim through it occasionally, and as you develop more and more, you'll learn the various commands.

-	==FTP Client and Code Editor==	+	==SFTP Client and Code Editor==

	You need both of these things, and it is highly preferable that you have instances of each that can interact with the other.		You need both of these things, and it is highly preferable that you have instances of each that can interact with the other.

-	An FTP client is a program you can use to transfer files to and from an FTP server. Lost Souls is such a server. You will be able to transfer files to and from your home directory. There are a number of free FTP clients. A code editor is just a plain text editor that has certain capabilities for dealing with structured code, the most important of which is colorizing various things. The ideal situation is to have a code editor which you can use to "directly" edit files on the server. (Directly is in quotes because the actual mechanics of this usually involve saving to a temporary file on your computer and then uploading, but it happens behind the scenes and you don't need to worry about it.) Otherwise you will have to save the file, then upload it, instead of just saving and uploading in one step. Given the amount of screwing up/minor modifications you will be doing, this extra step can become an egregious pain in the ass.	+	In order to access your /w directory via SFTP, you will need to generate RSA key pair and provide the public key to the developer who is assisting you with setup. Note that the private key should be kept secure and should never be shared.
		+
		+	A SFTP client is a program you can use to transfer files to and from an SFTP server. Lost Souls is such a server. You will be able to transfer files to and from your home directory. There are a number of free SFTP clients. A code editor is just a plain text editor that has certain capabilities for dealing with structured code, the most important of which is colorizing various things. The ideal situation is to have a code editor which you can use to "directly" edit files on the server. (Directly is in quotes because the actual mechanics of this usually involve saving to a temporary file on your computer and then uploading, but it happens behind the scenes and you don't need to worry about it.) Otherwise you will have to save the file, then upload it, instead of just saving and uploading in one step. Given the amount of screwing up/minor modifications you will be doing, this extra step can become an egregious pain in the ass.
		+
		+	Starhound has developed a Lost Souls-specific LPC language plugin for Visual Studio Code (VS Code). VS Code is a code editor available for most operating systems, and has available plugins that will allow it to communicate with the Lost Souls server via SFTP/SSH. Additional recommendations appear below:

	For Mac people, I recommend [http://cyberduck.ch/ Cyberduck] and either [http://www.barebones.com/ BBEdit] or [http://www.codingmonkeys.de/subethaedit/ SubEthaEdit]. Either of these should interface with Cyberduck (check the Cyberduck preferences and documentation for how). It might take some fiddling to get this to work. As the program is frequently updated, I'm not going to provide a step-by-step for this, but it isn't so complicated.		For Mac people, I recommend [http://cyberduck.ch/ Cyberduck] and either [http://www.barebones.com/ BBEdit] or [http://www.codingmonkeys.de/subethaedit/ SubEthaEdit]. Either of these should interface with Cyberduck (check the Cyberduck preferences and documentation for how). It might take some fiddling to get this to work. As the program is frequently updated, I'm not going to provide a step-by-step for this, but it isn't so complicated.
Line 64:		Line 68:

	Kabal uses [http://www.jgrasp.org/ jGRASP], which is free but may be a little heavyweight for some.		Kabal uses [http://www.jgrasp.org/ jGRASP], which is free but may be a little heavyweight for some.
-
-	The information you will use to login is: host: lostsouls.org, port: 21, username: your '''developer''' name, all lowercase, password: your '''atman''' password.

	==Coding==		==Coding==

Chaos: /* Further Reading */

Chaos — Thu, 31 Jul 2008 13:33:28 GMT

Chaos at 19:52, 30 July 2008

Chaos — Wed, 30 Jul 2008 19:52:16 GMT

←Older revision		Revision as of 19:52, 30 July 2008
Line 9:		Line 9:
	*If you get zapped by a dev -- a likely fate for new developers -- or whatever, just "heal me" to heal yourself.		*If you get zapped by a dev -- a likely fate for new developers -- or whatever, just "heal me" to heal yourself.

-	*If you want to regain mortality or other such gifts, the following aliases will help you easily toggle their existance:	+	*If you want to regain mortality or other such gifts, the following aliases will help you easily toggle their existence:
	set alias imm to set immortality on;set invulnerability on;set omniloquence on;set omniscience on		set alias imm to set immortality on;set invulnerability on;set omniloquence on;set omniscience on
	set alias mort to set immortality off;set invulnerability off;set omniloquence off;set omniscience off		set alias mort to set immortality off;set invulnerability off;set omniloquence off;set omniscience off

Jensendied: added mort and imm alias listings

Jensendied — Wed, 30 Jul 2008 19:51:25 GMT

added mort and imm alias listings

←Older revision		Revision as of 19:51, 30 July 2008
Line 8:		Line 8:

	*If you get zapped by a dev -- a likely fate for new developers -- or whatever, just "heal me" to heal yourself.		*If you get zapped by a dev -- a likely fate for new developers -- or whatever, just "heal me" to heal yourself.
		+
		+	*If you want to regain mortality or other such gifts, the following aliases will help you easily toggle their existance:
		+	set alias imm to set immortality on;set invulnerability on;set omniloquence on;set omniscience on
		+	set alias mort to set immortality off;set invulnerability off;set omniloquence off;set omniscience off

	*To move yourself somewhere quiet, "goto" a person, preferably a dev in a non-player room. E.g. "goto chaos".		*To move yourself somewhere quiet, "goto" a person, preferably a dev in a non-player room. E.g. "goto chaos".

Zyll at 16:32, 25 March 2008

Zyll — Tue, 25 Mar 2008 16:32:20 GMT

←Older revision		Revision as of 16:32, 25 March 2008
Line 104:		Line 104:

	Happy developing!		Happy developing!
		+
		+	[[Category: Development]]

Bladestorm: /* FTP Client and Code Editor */

Bladestorm — Mon, 10 Sep 2007 00:43:50 GMT

FTP Client and Code Editor

←Older revision		Revision as of 00:43, 10 September 2007
Line 55:		Line 55:
	For Mac people, I recommend [http://cyberduck.ch/ Cyberduck] and either [http://www.barebones.com/ BBEdit] or [http://www.codingmonkeys.de/subethaedit/ SubEthaEdit]. Either of these should interface with Cyberduck (check the Cyberduck preferences and documentation for how). It might take some fiddling to get this to work. As the program is frequently updated, I'm not going to provide a step-by-step for this, but it isn't so complicated.		For Mac people, I recommend [http://cyberduck.ch/ Cyberduck] and either [http://www.barebones.com/ BBEdit] or [http://www.codingmonkeys.de/subethaedit/ SubEthaEdit]. Either of these should interface with Cyberduck (check the Cyberduck preferences and documentation for how). It might take some fiddling to get this to work. As the program is frequently updated, I'm not going to provide a step-by-step for this, but it isn't so complicated.

-	''Someone give PC recommendations please? I'm way out of date. I know Chance likes Crimson. Presumably *nix people will know what to do without my telling them.''	+	''Someone give PC recommendations please? I'm way out of date. I know Chance likes [[Crimson]]. Presumably *nix people will know what to do without my telling them.''

	Slash uses [http://www.editplus.com EditPlus] on his PC (it's a code editor with FTP).		Slash uses [http://www.editplus.com EditPlus] on his PC (it's a code editor with FTP).

Chaos: /* Coding */ adding note on 'perform project setup'

Chaos — Mon, 06 Aug 2007 20:16:00 GMT

Coding - adding note on 'perform project setup'

←Older revision		Revision as of 20:16, 6 August 2007
Line 80:		Line 80:

	Formal non-LS-specific documentation on LPC coding can be found [http://www.mars.org/home/rob/docs/BasicLPC/Contents.html here]. It's actually quite useful, though I recommend mucking around a bit before you delve in. Certain things in it will be inapplicable here, and are often easier, because of the work Chaos has done on our core library. However, it will teach you important basic concepts, like what a function is and what the parts of a function are, that will be quite applicable.		Formal non-LS-specific documentation on LPC coding can be found [http://www.mars.org/home/rob/docs/BasicLPC/Contents.html here]. It's actually quite useful, though I recommend mucking around a bit before you delve in. Certain things in it will be inapplicable here, and are often easier, because of the work Chaos has done on our core library. However, it will teach you important basic concepts, like what a function is and what the parts of a function are, that will be quite applicable.
		+
		+	There is a 'perform project setup' command that interactively helps you create the basic infrastructure for your new projects. See 'help perform project setup'. This only handles basic structure; it is not [[OLC]].

	Don't feel shy about asking coding questions on the dev channel.		Don't feel shy about asking coding questions on the dev channel.

Chaos: /* A Few Necessities */

Chaos — Sat, 14 Jul 2007 12:30:17 GMT

A Few Necessities

←Older revision		Revision as of 12:30, 14 July 2007
Line 12:		Line 12:

	*There are several commands that let you review changes to the MUD that are important and that you get in the habit of using immediately. These are "show changes", "promotions", and "privs". You should probably <pre>set alias since to show changes since;promotions since;privs since</pre> and be in the habit of using that alias at least once per login. (The first time you do this you will probably be spammed, as it will give you the entire changelog; don't feel obligated to read through it all.) You can also use these commands with other arguments, such as "show change 1" to see the most recent change ("help change" for the full range of possibilities).		*There are several commands that let you review changes to the MUD that are important and that you get in the habit of using immediately. These are "show changes", "promotions", and "privs". You should probably <pre>set alias since to show changes since;promotions since;privs since</pre> and be in the habit of using that alias at least once per login. (The first time you do this you will probably be spammed, as it will give you the entire changelog; don't feel obligated to read through it all.) You can also use these commands with other arguments, such as "show change 1" to see the most recent change ("help change" for the full range of possibilities).
		+
		+	*Most people have terminal windows 80 characters wide. It will probably be very helpful to you if you change this to 132 characters, or your terminal program's maximum width, whatever you can do.

	With that being said, its time to familiarize yourself with the structural backbone of Lost Souls.		With that being said, its time to familiarize yourself with the structural backbone of Lost Souls.

Chaos: /* The File Structure and the Command Line */

Chaos — Thu, 28 Jun 2007 16:39:38 GMT

The File Structure and the Command Line

←Older revision		Revision as of 16:39, 28 June 2007
Line 19:		Line 19:
	If you're familiar with command line interfaces (CLIs), this will be old hat. If not, it may take some getting used to. This document will at least assume you are familiar with directory trees, i.e. that you know at least what the various components of "C:\windows\system" designate. If you don't and you can't figure it out, then, I'm sorry to say, you just need to learn more about computers in general before you start coding for Lost Souls.		If you're familiar with command line interfaces (CLIs), this will be old hat. If not, it may take some getting used to. This document will at least assume you are familiar with directory trees, i.e. that you know at least what the various components of "C:\windows\system" designate. If you don't and you can't figure it out, then, I'm sorry to say, you just need to learn more about computers in general before you start coding for Lost Souls.

-	*Your '''home directory'''--where you can directly upload and download files from via FTP (see below)--is /w/devname. So for me, Twilight, my home directory would be /w/twilight.	+	*Your '''home directory''' -- where you can directly upload and download files from via FTP (see below) -- is /w/''devname''. So for me, Twilight, my home directory would be /w/twilight.

	*The '''cd''' command stands for "change directory", and is used to navigate from one folder to another. When used by itself, without any other arguments, it moves you to your home directory. "cd .." will move up one directory and is used to predicate relative movement within a file structure (e.g. "cd ../etc" will move you from "/w/twilight/Hanoma/dmn" to /w/twilight/Hanoma/etc"). "cd /" will move to the root directory and is used to predicate absolute movement (e.g. "cd /w/twilight/Hanoma/etc" will move you there no matter where you are).		*The '''cd''' command stands for "change directory", and is used to navigate from one folder to another. When used by itself, without any other arguments, it moves you to your home directory. "cd .." will move up one directory and is used to predicate relative movement within a file structure (e.g. "cd ../etc" will move you from "/w/twilight/Hanoma/dmn" to /w/twilight/Hanoma/etc"). "cd /" will move to the root directory and is used to predicate absolute movement (e.g. "cd /w/twilight/Hanoma/etc" will move you there no matter where you are).
Line 29:		Line 29:
	*'''cp''' and '''mv''' respectively copy and move files. To rename a file you use mv within a directory ("mv workroom.c workroom.c.old" renames the former file to the latter).		*'''cp''' and '''mv''' respectively copy and move files. To rename a file you use mv within a directory ("mv workroom.c workroom.c.old" renames the former file to the latter).

-	*'''rm''' deletes files. The files will be moved to /tmp/.removed/ for a short time, or until they are ovewritten by you deleting a file with an identical name. Note in this regard that deleting a file is actually less hazardous than overwriting one with a bad "cp" or "mv" command. Try not to do that, it sucks.	+	*'''rm''' deletes files. The files will be moved to /tmp/.removed/ for a short time, or until they are overwritten by you deleting a file with an identical name. Note in this regard that deleting a file is actually less hazardous than overwriting one with a bad "cp" or "mv" command. Try not to do that, it sucks.

	*If you have the [[privileges]] to write in a directory, you can use '''mkdir''' to make a new directory.		*If you have the [[privileges]] to write in a directory, you can use '''mkdir''' to make a new directory.

←Older revision		Revision as of 13:33, 31 July 2008
Line 91:		Line 91:
	==Further Reading==		==Further Reading==

-	*'''After''' you get familiar with being a developer and what possibilities are open to you, you should read "man developer". Reading it beforehand will probably just be confusing, but it contains the rules and guidelines and behaviors expected of you as a developer.	+	*'''After''' you get familiar with being a developer and what possibilities are open to you, you should read "man developer". Reading it beforehand will probably just be confusing, but it contains the rules and guidelines and behaviors expected of you as a developer. Pay particular attention to the section about actively participating in the MUD.

	*While you will learn coding primarily by example, there are some very bad examples of code out there, and it can be hard to tell what is what. To innoculate yourself from the worst aspects of this, read "man style" for our standard coding styles. Some of this may be hard to understand at first, so you'll probably want to check back after you've learned some more code.		*While you will learn coding primarily by example, there are some very bad examples of code out there, and it can be hard to tell what is what. To innoculate yourself from the worst aspects of this, read "man style" for our standard coding styles. Some of this may be hard to understand at first, so you'll probably want to check back after you've learned some more code.