[Mod] Guidebook Library [guidebooks]

User avatar
PolySaken
Member
 
Posts: 427
Joined: Thu Nov 09, 2017 05:18
Location: djelibabi
GitHub: PolySaken-I-Am
In-game: PolySaken

[Mod] Guidebook Library [guidebooks]

by PolySaken » Wed Oct 30, 2019 05:16

Image
A heavily extended version of an API from ocular_networks, guidebooks is a library mod which allows the creation of in-game documentation in the form of an item.
This item is called a 'book' internally (although it doesn't have to be a book to the user) and will open a formspec when used.
This formspec is easy to create, as you only need a width, height, and background image.
Each book can hold up to 28 'sections' which can hold pages, or subsections.
subsections can only hold pages.
pages are defined using two text fields but also support the use of a custom formspec string.

(This mod doesn't add any content on its own other than an example book)

+ api


+ screenshots (from example book)


Download latest

license of media and source: CC-BY-SA 4.0

no dependencies
Last edited by PolySaken on Thu Nov 14, 2019 08:23, edited 1 time in total.
 

User avatar
runs
Member
 
Posts: 1010
Joined: Sat Oct 27, 2018 08:32
GitHub: runsy
 

CalebJ
Member
 
Posts: 203
Joined: Sat Dec 29, 2018 19:21
Location: Tunnelers' Abyss
GitHub: KaylebJay
IRC: KaylebJay
In-game: CalebJ

Re: [Mod] Guidebook Library [guidebooks]

by CalebJ » Wed Oct 30, 2019 15:55

Very impressive indeed! This looks well done, I'll try it out soon :)
If you want realism, you're in the wrong place. Get off your mobile.
 

User avatar
PolySaken
Member
 
Posts: 427
Joined: Thu Nov 09, 2017 05:18
Location: djelibabi
GitHub: PolySaken-I-Am
In-game: PolySaken

Re: [Mod] Guidebook Library [guidebooks]

by PolySaken » Wed Oct 30, 2019 20:56

Glad you guys like it! I'm planning to make support for unlockable sections, so that there is a degree of progression to the books.
 

Sokomine
Member
 
Posts: 3952
Joined: Sun Sep 09, 2012 17:31
GitHub: Sokomine

Re: [Mod] Guidebook Library [guidebooks]

by Sokomine » Wed Oct 30, 2019 22:29

Looks very nice. Hope this and other book mods get a wider use on servers.
A list of my mods can be found here.
 

User avatar
PolySaken
Member
 
Posts: 427
Joined: Thu Nov 09, 2017 05:18
Location: djelibabi
GitHub: PolySaken-I-Am
In-game: PolySaken

Re: [Mod] Guidebook Library [guidebooks]

by PolySaken » Wed Oct 30, 2019 22:42

Sokomine wrote:Looks very nice. Hope this and other book mods get a wider use on servers.

I've noticed that people don't seem to use the books in default much or at all in servers, which is pretty much the only place other than maps they might be useful.
 

User avatar
Lone_Wolf
Member
 
Posts: 2250
Joined: Sun Apr 09, 2017 05:50
Location: Not there, THERE!
GitHub: LoneWolfHT
IRC: Lone_Wolf or LoneWolfHT
In-game: Lone_Wolf
 

User avatar
PolySaken
Member
 
Posts: 427
Joined: Thu Nov 09, 2017 05:18
Location: djelibabi
GitHub: PolySaken-I-Am
In-game: PolySaken

Re: [Mod] Guidebook Library [guidebooks]

by PolySaken » Fri Nov 15, 2019 22:52

Lone_Wolf wrote:Neat! I'll have to try this out...

Could you show me your results? I'd like to know what people are using it for in order to tailor it to better suit a broader range of uses.
 

User avatar
Lone_Wolf
Member
 
Posts: 2250
Joined: Sun Apr 09, 2017 05:50
Location: Not there, THERE!
GitHub: LoneWolfHT
IRC: Lone_Wolf or LoneWolfHT
In-game: Lone_Wolf

Re: [Mod] Guidebook Library [guidebooks]

by Lone_Wolf » Sat Nov 16, 2019 02:11

PolySaken wrote:
Lone_Wolf wrote:Neat! I'll have to try this out...

Could you show me your results? I'd like to know what people are using it for in order to tailor it to better suit a broader range of uses.

Sure, may be a while yet though. I have a few things to code until I get to the point where I'm adding books into the game lol
Content DB -|- Working on Voxel Knights
 

User avatar
PolySaken
Member
 
Posts: 427
Joined: Thu Nov 09, 2017 05:18
Location: djelibabi
GitHub: PolySaken-I-Am
In-game: PolySaken

Re: [Mod] Guidebook Library [guidebooks]

by PolySaken » Sat Nov 16, 2019 02:32

Lone_Wolf wrote:
PolySaken wrote:
Lone_Wolf wrote:Neat! I'll have to try this out...

Could you show me your results? I'd like to know what people are using it for in order to tailor it to better suit a broader range of uses.

Sure, may be a while yet though. I have a few things to code until I get to the point where I'm adding books into the game lol

That's cool. What are you making?
 

User avatar
PolySaken
Member
 
Posts: 427
Joined: Thu Nov 09, 2017 05:18
Location: djelibabi
GitHub: PolySaken-I-Am
In-game: PolySaken

Re: [Mod] Guidebook Library [guidebooks]

by PolySaken » Sat Nov 16, 2019 02:34

double post
Last edited by PolySaken on Sat Nov 16, 2019 04:05, edited 2 times in total.
 

User avatar
PolySaken
Member
 
Posts: 427
Joined: Thu Nov 09, 2017 05:18
Location: djelibabi
GitHub: PolySaken-I-Am
In-game: PolySaken

Re: [Mod] Guidebook Library [guidebooks]

by PolySaken » Sat Nov 16, 2019 02:36

edit: removed doublepost
Last edited by PolySaken on Sat Nov 16, 2019 04:05, edited 1 time in total.
 

User avatar
PolySaken
Member
 
Posts: 427
Joined: Thu Nov 09, 2017 05:18
Location: djelibabi
GitHub: PolySaken-I-Am
In-game: PolySaken

Re: [Mod] Guidebook Library [guidebooks]

by PolySaken » Sat Nov 16, 2019 04:03

The bug causing locked sections to show up when they're not supposed to has been fixed, Along with the ordering system.
Sections will now display in the order of registration rather than size.
 

User avatar
PolySaken
Member
 
Posts: 427
Joined: Thu Nov 09, 2017 05:18
Location: djelibabi
GitHub: PolySaken-I-Am
In-game: PolySaken

Re: [Mod] Guidebook Library [guidebooks]

by PolySaken » Mon Dec 09, 2019 07:41

Attention: A bug has been discovered that causes crashing and corruption when more than one book is registered. Unless you have a fix, I wouldn't recommend using this mod for now.
(I have no idea why this bug is happening, it seems to be part of the show_formspec code)
 

User avatar
Lone_Wolf
Member
 
Posts: 2250
Joined: Sun Apr 09, 2017 05:50
Location: Not there, THERE!
GitHub: LoneWolfHT
IRC: Lone_Wolf or LoneWolfHT
In-game: Lone_Wolf

Re: [Mod] Guidebook Library [guidebooks]

by Lone_Wolf » Mon Dec 09, 2019 15:52

PolySaken wrote:Attention: A bug has been discovered that causes crashing and corruption when more than one book is registered. Unless you have a fix, I wouldn't recommend using this mod for now.
(I have no idea why this bug is happening, it seems to be part of the show_formspec code)

What's the error?
Content DB -|- Working on Voxel Knights
 

User avatar
PolySaken
Member
 
Posts: 427
Joined: Thu Nov 09, 2017 05:18
Location: djelibabi
GitHub: PolySaken-I-Am
In-game: PolySaken

Re: [Mod] Guidebook Library [guidebooks]

by PolySaken » Tue Dec 10, 2019 04:06

Lone_Wolf wrote:
PolySaken wrote:Attention: A bug has been discovered that causes crashing and corruption when more than one book is registered. Unless you have a fix, I wouldn't recommend using this mod for now.
(I have no idea why this bug is happening, it seems to be part of the show_formspec code)

What's the error?

The index page is not showing, despite all of the checks being met. In the rare event that it does, it shows for a few microseconds at most before crashing the game.
 

User avatar
Pyrollo
Member
 
Posts: 333
Joined: Mon Jan 08, 2018 15:14
Location: Paris
GitHub: pyrollo
In-game: Naj

Re: [Mod] Guidebook Library [guidebooks]

by Pyrollo » Tue Dec 10, 2019 10:05

Hypertext formspec element and its markup language can improve your mod's look and feel. It's not yet in stable version, but you can yet test it on dev version.
[ Display Modpack ] - [ Digiterms ] - [ Crater MG ] - [ LATE ]
 

User avatar
PolySaken
Member
 
Posts: 427
Joined: Thu Nov 09, 2017 05:18
Location: djelibabi
GitHub: PolySaken-I-Am
In-game: PolySaken

Re: [Mod] Guidebook Library [guidebooks]

by PolySaken » Tue Dec 10, 2019 22:20

Pyrollo wrote:Hypertext formspec element and its markup language can improve your mod's look and feel. It's not yet in stable version, but you can yet test it on dev version.

Excuse me if I'm missing something, but this doesn't seem all that relevant. (Unless it's a general suggestion, In which case I'll look into it.)
Last edited by PolySaken on Tue Dec 10, 2019 22:39, edited 1 time in total.
 

User avatar
PolySaken
Member
 
Posts: 427
Joined: Thu Nov 09, 2017 05:18
Location: djelibabi
GitHub: PolySaken-I-Am
In-game: PolySaken
 

User avatar
PolySaken
Member
 
Posts: 427
Joined: Thu Nov 09, 2017 05:18
Location: djelibabi
GitHub: PolySaken-I-Am
In-game: PolySaken

Re: [Mod] Guidebook Library [guidebooks]

by PolySaken » Thu Dec 19, 2019 01:43

good news! I managed to fix the bug. (apparently setting the player's wielded item from inside on_player_receive_fields will cause any following code to terminate. i worked around this by using minetest.after(0))
 


Return to Mod Releases



Who is online

Users browsing this forum: No registered users and 3 guests