Id like to create book to help beginners about solarus editor

Started by 20degree, September 06, 2015, 06:35:39 PM

Previous topic - Next topic
I have updated the pdf file that have 7 pages now. If you want you can take a look:

Ive added 2 pages to the pdf guide. One page that say where to download Solarus Quest Maker, and one page that say where to download the Zelda a Link to the Past Resources Pack.

It's a very nice idea you have Zefk for helping peoples find and download Solarus. I dont read too much the Github issues, but still i read them when i have time; i prefere by the forum here issues.

If some peoples have nice step-by-step "little" ideas that can use the ALTTP Pack, so that i can do and experiment and other peoples can do and experiments; it would be very nice! Things that you already know exactly how to do and program.

Examples: Break some vase that make apear some heart. Pick-up some shield. Create some pause items-menu. Simple things to do in the first pages, later on medium level things to do; later on advanced things to do. The peoples must understand small steps, even i must understand small steps before doing some big steps.

Thank's Christopho for letting me do printscreens to put in the pages. I dont know much about Solarus, but try things with it. Ive always wanted to create my own Super Nes Zelda style free personnal game, with a free software that can do it.

Once again, thank's to all!


QuoteIt's a very nice idea you have Zefk for helping peoples find and download Solarus. I dont read too much the Github issues, but still i read them when i have time; i prefere by the forum here issues.

You're welcome.

The issues I made on GitHub are a little unorganized. I will probably go through them sometime and refine the issues. I will most likely will do that when solving the chapter issue, but the chapters will most likely change overtime, but it is good for the thinking process.

The community is probably watching this project, but are still waiting for basic progress before contributing. Most of their code is free to use. (At least the code they released publicly) The community is always willing to help to solve script problems. In my case, I am just bored on my breaks and doing some volunteer service for the book is more fun.  ;D

I will probably make a bank script next. I already made out some pseudo code and will cover some lua programming that I did not do in the volume control script.

Ive done a very tiny change of the pdf file. I know that ive asked yourself if i can put your nick name, and you did not givin me the authorizations. Still ive put your nick name in the page "Terms", just to give you my thank's Zefk. It's maybe not necessary for your self that i do, but for me it is to give my thank's and appreciations. I also appreciate very much Christopho also Diarandor that have posted here on the project.

The administrators of and, knows how much for me it is important to give my thank's and appreciations to peoples. As i find it important to say it to my mother, my father, my brothers, my friends; brief the peoples that surround my self. Even Ton Roosendaal from know my appreciations.

I know it is out of the subject, but peoples that read this at leass please tell to your surrounding; how much you appreciate them, like them and love them. Me i dont know when my mom or dad, friends, etc, will be there no more. So it's important to tell at leass once a while to your surrounding, how much your care, how much you appreciate them.

Once again thank's for all your help.


I want to add a page about free graphics and audio files that can be used to create free games or commercial games. An example is:, or

Ive updated the pdf guide, it has now 11 pages. It have the simple link to the files of Diarandor and Zefk. It say fiew operating system that Solarus can be put on. It give link's to free graphical tool software and free audio tool software. It have fiew other links to some documentations also. Well i'll hope it will help peoples? There is much to do, to be done; as told it's under construction.


I began listing chapters and will post issues based on it. That way I can see if I can solve some while scripting.

For the license link you added:*
I took my text from the license page and attached it here on this post in a document form. It will be good for people without "much" internet access. It would be good to add to the book.

For the menu documentation link:*
I think there is no need for then "menu" link because you already added a link to the documentation. It might begin to become a mess if one were to add all the documentation links....I think the PDF version of the documentation covers it.

For the software links:*
It would be nice to categorize them. For example, audio, graphic, etc. That way you will not have to describe the software. You could provide a link to the Solarus help guide for description needs or to their website. I mention quite a bit of free software that you can add.



Font: (I will have to finish that bash script mod....forgot about it),611.msg3757.html#msg3757

At the bottom of this post is more font programs:,636.msg3236.html#msg3236

Advanced Screen Capture Tools:

  • Shutter for Linux -There are many options. The most important is selecting an area on the screen and making a screenshot. There are some basic paint editing tools as well.
  • Greenshot for Windows -There are many options. The most important is selecting an area on the screen and making a screenshot.
  • The use of gifs might be better than videos for reporting bugs. They are easier to post and upload. Giphy might be a good place to upload them before posting...only if they are bigger than 100 kb. Silentcast for Linux and ScreenToGif for Windows.

Mind mapping:,611.msg3430.html#msg3430

Office Suites:,611.msg3431.html#msg3431

For Diarandor's works:*
It would be nice to mention that quite a bit of his work is packed in the Solarus "Sample Quest" that comes with the Solarus download. Also, that he can be contacted. He mentions email, so I am guessing that is the the email he provided on the forum.

Ive modified the pdf at page 7, modified a bit page 6; and ive added Zefk Basic License Informations. It have now 19 pages.


That was fast. The book is looking great! You can add the document I added to this post to the book. The rest of the files are here That is all the files for the volume control script. (Including the gimp menu xcf) You can upload it at Github to use it as a sample. Only 2.5 MB and before the start of the section tell them to check the volume control script sample, so they can see the code in action.

Let me know if Mega gives you a huge wait time. It does that for Germany IP address sometimes and I am not sure if they have limits for other countries. It is almost no wait time in the USA.

Ive added 2 pages into the pages, so some pdf pages are on other page. On page 8 i have told how to do some printscreens with windows. On page 13 ive told how to create some staring position, if some people want to try there player on some map. As you see i try to understand more Solarus it's not easy for me as a beginner.

You say Zefk its great work, but there is much to do. Thank's for the help!


You're welcome. I will be busy, but I will see what else I can do for the book. I should have the chapters done tomorrow, but of course it will change a lot. I can just add more issues to solve on GitHub. I will go through some of the tutorials and code I studied, so it can be added to the book. I will first complete the bank script. I didn't have time today to work on it, but tomorrow for sure.

Now i'm reading a bit about "stairs and bridge" that is on the site:
To make readers know how to do some stairs and bridge for there zelda. I will indicate to copy the code of the file "quest_manager.lua" said on the site to donwload and simply put at some directory. This because i dont know if the reader would read the pdf guide and be on the internet. So thinking the reader is not on the web, copying/writing the code in the pages and put it in the file with Notepad++ should help.

Ive got to go prepare things for tomorrow as going to work, gonna continue later the pages about stairs and bridge. Here in the province of Quebec when it is here 20h30pm, in France is 2h30am.

If you Zefk or others know how to do simple things, would be great! Even I as a beginner must learn to do simple things.


I try to understand the Bridge Method of the previous link, but it dont work or i must do something wrong. I must do some experimenting of the things i see and read here and others to make me more know Solarus to help better in the book.

Here is the map i try to do some stairs that go up and down:, you can see the room. The floor is at level 0, the Destination is at level 0, the tileset is "house", the specific house tileset is (patern id: stairs_inner_up.2) have said also that the ground of it is "ladder" at layer 0. Ive told that (patern id: is also "ladder" at layer 1. The (patern id: stairs_inner_up.2.border.1) is a "wall" at layer 0. Then (patern id: is a "wall" at layer 1.

Next ive put two sensors. The one at the bottom of the stairs is called "Down_layer" and is on layer 1. The other sensor is named "Up_layer" and is on layer 0. The sensors have some distance between them of one step. Also i have created some floor at the end the stairs, that the tile is (patern id: floor.2) and is on layer 1. Link can pass under the (patern id: floor.2), but when he climb the stairs "ladder" he should turn out to be at layer 1 so can walk on (patern id: floor.2) and not be under??

It's strange? Following the ive downloaded the file "quest_manager.lua" put it in the correct directory, knowing it is in the good directory because i can see it in the tree. Ive not modified the "quest_manager.lua" file. Also i have added in the "main.lua" file:  local quest_manager = require("scripts/quest_manager"). As told on the site. When i test it dont work?? Even putting the sensors at different places so that Link can step-onto dont not make him be at layer 0 to layer 1 and vice-versa? Ive simply only said what is the ladder and simply added two sensors on the tile. What i have done wrong?

Because it's a part that i would like to know to teach in the book, to make Link climb some stairs to be on some other floor higher. The next thing id like that the reader can do as an other exercise, is beeing then on the higher floor can simply fall down to the layer below.

What i think to have understand but not sure "i'm a beginner" is that in the "main.lua" file when you write as:  local quest_manager = require("scripts/quest_manager"). It indicate to the file "main.lua" to go see the file named "quest_manager.lua" then after it is writen the patern of where the file is; if i'm correct?


I have made a little update of the free pdf book: There is much i must learn about Solarus. There is a page that explain how to indicate and program on what place your hero start. There is also a page about the Solarus Quest List Player; that give basic infos about making your logo for your game and icon.

Thank's Zefk for suggesting to me, to do some keyboard/mouse shortcuts. Like when your into Solarus Quest Editor, and you press the keyboard key's ( CTRL + P ), it make apear the "Properties" of your quest. I have not put it for now into the book, but later will be good.