Have you ever been playing in a big modpack, or even regular Minecraft, and you have no idea what in the world the item you just found does? Well my friend, I have a solution for you.
WikiLinks is my first ever project in Minecraft development that I would like to share with the public. I designed it because I was tired of hearing people on Youtube say “Oh, what does this do?” With my mod, all you have to do is type /wiki <search term> and it will open up an information source in your default web browser automatically.
I need people to test and see if this works properly on Mac OS and Unix/Linux Machines. Thank you.
If you are interested in knowing something about an item, just use the /wiki command as so: /wiki <wiki key> <search term>
<wiki key> = Specific Wiki that you want to search in. If you don't want to search a specific wiki, not entering the wiki key will result in the mod searching on the default wiki.
<search term> = The subject you want to search. It can be practically anything.
Final example: /wiki ftb im a noob at thaumcraft plz help me
Wiki Options
If you want to add different wikis for different mods, those are now handled by the mod author. If you would like to request a mod to be added to WikiLink, please contact the author of the mod. However, here are the three built in wikis I have installed with their keys:
Again, this mod is in it’s early stages of alpha. If you have any suggestions, please feel free to write them here. I am open for anything and everything, as this is my first learning experience with programming.
Planned Features
NEI Integration
GUI Option Menu for Configurations
This isn't the best photo, but I'm not really sure what else I can show. This is the text output after you enter the command. It tells you what you searched for and where it's taking you.
If you are a mod developer and you are interested in including your mod's wiki in WikiLink, you can extend it's API by adding this interface to your mod. If you have a wiki software that is not supported, please tell me and I will add it into the next version of WikiLink! (At least until I can get the custom wiki system going)
As long as this is somewhere in your mod, WikiLinks will pick it up and add your wiki to the database. It's up to you for now to "advertise" your wiki key until I can get a good system for sharing them.
In "Plugin<Modname>Wiki".class
package mod.package;
public class Plugin<modname>Wiki implements Plugin
{
/** Is this plugin available for WikiLink
* to use?
*
* true/false
*
* @since 1.6.2-011
*/
@Override
public boolean isAvailable() {
return true;
}
/** Please enter the @modid value here.
* It's not used yet, but it will be used
* for NEI integration in a later update.
*
* @since 1.6.2-011
*/
@Override
public String getModID() {
return "";
}
/** This is the "code" to access your wiki.
* /wiki <key> <query>
*
* Please replace "key" with your unique acronym.
*
* @since 1.6.2-010
*/
@Override
public String getWikiKey() {
return "key";
}
/** This is the english name of your wiki.
* "Example Wiki"
*
* @since 1.6.2-010
*/
@Override
public String getWikiName() {
return "";
}
/** This is the domain name of your wiki.
* "wiki.example.com"
*
* Please do not add any slashes!
*
* @since 1.6.2-010
*/
@Override
public String getWikiDomain() {
return "";
}
/** This is the software name of your wiki.
* "MEDIAWIKI","DOKUWIKI","WIKIA","WIKISPACES","PHPWIKI"
*
*
* You can create a custom one, just follow the
* instructions on the forum post.
*
* @since 1.6.2-010
*/
@Override
public String getWikiSoftware() {
return "";
}
/** This is not implemented yet! Do not use!
*
* @since 1.6.2-011
*/
@Override
public String getCustomWikiSearchFormat() {
return null;
}
}
I would like to thank everyone who has helped me with this project, as if it weren't for your support and guidance I most likely would have not come this far. There are also a couple of folks in particular who I would like to personally thank;
Vswe, You're a great modder and a great teacher. I really enjoyed learning with your video course. The amount of effort put in to those videos is incredible. Your series is the best on Youtube and I really hope you are proud of it.
ScottKillen, I'm not sure if when you asked if I wanted to implement mod support into WikiLink you realized I was a novice programmer, but you took the extra steps of talking me through the problems I was having and I really appreciated that. Thank you for helping me out, because I couldn't have mod integration without you!
you should make an API so modders can add commands
In the future, sure. I want it to automatically look at the mods added and compare it with a list of wikis. You'll be able to press a button in the NEI GUI that will open a wiki, much like when you press a R for a recipe in NEI.
Installed! Works great! Lags the game out tho when spammed *g*
Well it is using extra processor to open up a new instance of your default browser, so I'd expect that xD. Mind if I ask what OS you're running?
Edit: I saw your edit: Sure, my skype should be in my profile for the forums if you can add me there. If not just shoot me a message or tweet me @keepablock
things such being able to set wiki commands in the comfig
IE. /wiki MattaCraft (URL)
or
IE /wiki MattaCraft Buildcraft (URL)
Would rock because I have quite a lot of mods in my pack.
Thanks for the suggestion. I'll be sure to add this to the list of upcoming features. It just might take me a while to pull an update out of my sleeve because I'm still learning the ropes.
Very nice. I would be willing to help you write (actually it is already written) a piece that allows other mods to easily integrate. PM me if you are interested.
Are the mods listed above the only supported mods? I run Metallurgy, Aquaculture and a couple of other mods and I don't know if they would be supported or not.
Are the mods listed above the only supported mods? I run Metallurgy, Aquaculture and a couple of other mods and I don't know if they would be supported or not.
Yes, those are currently the only supported mods. I'm working on making my mod "smarter" so it will integrate with every mod that has a wiki. That should be next update -or two-.
Yes, those are currently the only supported mods. I'm working on making my mod "smarter" so it will integrate with every mod that has a wiki. That should be next update -or two-.
Well I did /wiki metallurgy then a item from it and it took me to minecraft wiki. It would be nice to have a auto complete that has the list of useable searches such as tc3 and the ones listed above.
This is a great idea. A lot of people, myself included, will load a lot of mods and forget what every single item and block does. This is a straight great idea.
Have you seen awesomium? It could be useful for this idea. Awesomium is a broken apart web browser that can integrated into other programs. So instead of loading the default web browser you could actually load a page inside a minecraft gui. Granted this is all very involved. It's just something I though I'd point out.
Regardless, your idea as is, is great.
Rollback Post to RevisionRollBack
If you think something's impossible.
You haven't tried hard enough.
This is a great idea. A lot of people, myself included, will load a lot of mods and forget what every single item and block does. This is a straight great idea.
Have you seen awesomium? It could be useful for this idea. Awesomium is a broken apart web browser that can integrated into other programs. So instead of loading the default web browser you could actually load a page inside a minecraft gui. Granted this is all very involved. It's just something I though I'd point out.
Regardless, your idea as is, is great.
I actually considered adding an in game browser for this, but I haven't committed to the idea yet just because this mod is so early in development. After looking at Awesomium though, it appears that it does not come with a Java bridge, so even if I wanted I would not be able to implement it into my mod. (Unless somehow I can install it with my mod and have it be a separate program)
I actually considered adding an in game browser for this, but I haven't committed to the idea yet just because this mod is so early in development. After looking at Awesomium though, it appears that it does not come with a Java bridge, so even if I wanted I would not be able to implement it into my mod. (Unless somehow I can install it with my mod and have it be a separate program)
Well, it was just an idea. I'm glad you took a look it at. Awesomium was just something I glanced over a couple days ago reseaching a different project. When I saw this thread the two ideas looked liked they'd go good together. But if there's no java support, then 'pppthf' to them.
Regardless, big supporter of this mod.
Rollback Post to RevisionRollBack
If you think something's impossible.
You haven't tried hard enough.
Well, it was just an idea. I'm glad you took a look it at. Awesomium was just something I glanced over a couple days ago reseaching a different project. When I saw this thread the two ideas looked liked they'd go good together. But if there's no java support, then 'pppthf' to them.
Works on Mac OS 10.6 only without spaces in search term.
Edit after reading the Thread more carefully:
Of course this didn't work xD
More testing!
Edit after more Testing:
It still works only as long as there are no spaces in the search term
For the hardcoded wikis I'd suggest config file options to specify default location and additional search urls
Hmm. Thanks for the report. I'm almost done adding an API where modders can define their own wikis for their mod, so the next version that is released will have that as well as a configuration option for default wikis.
I'm not sure about the no spaces in the search term part. I'll test it thoroughly on the one mac machine I have in my house for bugs before next release though
Edit: I've actually already figured it out. When you open a wiki up in my mod it literally takes your input such as "this is a wiki search" and enters it into a url like
I moved my topic to here!
Have you ever been playing in a big modpack, or even regular Minecraft, and you have no idea what in the world the item you just found does? Well my friend, I have a solution for you.
WikiLinks is my first ever project in Minecraft development that I would like to share with the public. I designed it because I was tired of hearing people on Youtube say “Oh, what does this do?” With my mod, all you have to do is type /wiki <search term> and it will open up an information source in your default web browser automatically.
I need people to test and see if this works properly on Mac OS and Unix/Linux Machines. Thank you.
If you are interested in knowing something about an item, just use the /wiki command as so:
/wiki <wiki key> <search term>
<wiki key> = Specific Wiki that you want to search in. If you don't want to search a specific wiki, not entering the wiki key will result in the mod searching on the default wiki.
<search term> = The subject you want to search. It can be practically anything.
Final example:
/wiki ftb im a noob at thaumcraft plz help me
Goes Here
Wiki Options
If you want to add different wikis for different mods, those are now handled by the mod author. If you would like to request a mod to be added to WikiLink, please contact the author of the mod. However, here are the three built in wikis I have installed with their keys:
The Current Version for Minecraft 1.6.2
Again, this mod is in it’s early stages of alpha. If you have any suggestions, please feel free to write them here. I am open for anything and everything, as this is my first learning experience with programming.
Planned Features
If you are a mod developer and you are interested in including your mod's wiki in WikiLink, you can extend it's API by adding this interface to your mod. If you have a wiki software that is not supported, please tell me and I will add it into the next version of WikiLink! (At least until I can get the custom wiki system going)
As long as this is somewhere in your mod, WikiLinks will pick it up and add your wiki to the database. It's up to you for now to "advertise" your wiki key until I can get a good system for sharing them.
In "Plugin<Modname>Wiki".class
I would like to thank everyone who has helped me with this project, as if it weren't for your support and guidance I most likely would have not come this far. There are also a couple of folks in particular who I would like to personally thank;
Follow me on twitter! @dreinsteinium
Thanks. I will be sure to keep working on it.
In the future, sure. I want it to automatically look at the mods added and compare it with a list of wikis. You'll be able to press a button in the NEI GUI that will open a wiki, much like when you press a R for a recipe in NEI.
Follow me on twitter! @dreinsteinium
Well it is using extra processor to open up a new instance of your default browser, so I'd expect that xD. Mind if I ask what OS you're running?
Edit: I saw your edit: Sure, my skype should be in my profile for the forums if you can add me there. If not just shoot me a message or tweet me @keepablock
Follow me on twitter! @dreinsteinium
things such being able to set wiki commands in the comfig
IE. /wiki MattaCraft (URL)
or
IE /wiki MattaCraft Buildcraft (URL)
Would rock because I have quite a lot of mods in my pack.
Thanks for the suggestion. I'll be sure to add this to the list of upcoming features. It just might take me a while to pull an update out of my sleeve because I'm still learning the ropes.
Follow me on twitter! @dreinsteinium
E-Mail - Google+ - Twitter
Yes, those are currently the only supported mods. I'm working on making my mod "smarter" so it will integrate with every mod that has a wiki. That should be next update -or two-.
Follow me on twitter! @dreinsteinium
Well I did /wiki metallurgy then a item from it and it took me to minecraft wiki. It would be nice to have a auto complete that has the list of useable searches such as tc3 and the ones listed above.
E-Mail - Google+ - Twitter
Have you seen awesomium? It could be useful for this idea. Awesomium is a broken apart web browser that can integrated into other programs. So instead of loading the default web browser you could actually load a page inside a minecraft gui. Granted this is all very involved. It's just something I though I'd point out.
Regardless, your idea as is, is great.
You haven't tried hard enough.
I am a representative of VudooHosting
I actually considered adding an in game browser for this, but I haven't committed to the idea yet just because this mod is so early in development. After looking at Awesomium though, it appears that it does not come with a Java bridge, so even if I wanted I would not be able to implement it into my mod. (Unless somehow I can install it with my mod and have it be a separate program)
Thanks. That's my goal
Follow me on twitter! @dreinsteinium
Well, it was just an idea. I'm glad you took a look it at. Awesomium was just something I glanced over a couple days ago reseaching a different project. When I saw this thread the two ideas looked liked they'd go good together. But if there's no java support, then 'pppthf' to them.
Regardless, big supporter of this mod.
You haven't tried hard enough.
Thanks.
Hmm. Thanks for the report. I'm almost done adding an API where modders can define their own wikis for their mod, so the next version that is released will have that as well as a configuration option for default wikis.
I'm not sure about the no spaces in the search term part. I'll test it thoroughly on the one mac machine I have in my house for bugs before next release though
Edit: I've actually already figured it out. When you open a wiki up in my mod it literally takes your input such as "this is a wiki search" and enters it into a url like
Safari can't understand the URL because it has spaces in it, so I must turn the spaces into + signs.
That will be fixed next version
Follow me on twitter! @dreinsteinium
+ API for modders
+ Configurations for default wiki
+ More efficient and clean code process
+ Fixed search term problem for Mac OS users!
Follow me on twitter! @dreinsteinium