[XDE] xDGameStudios Engine - AchievementSys v1.2 (UPDATE NEW!!)

Discussion in 'JS Plugin Releases (RMMV)' started by xDGameStudios, Jan 26, 2016.

  1. xDGameStudios

    xDGameStudios Veteran Veteran

    Messages:
    102
    Likes Received:
    56
    First Language:
    Portuguese
    XDE_AchievementsSys +v1.2
    xDGameStudios



    Introduction
     This plugin enables the creation of a achievement system that helps the developers to create more in-depth game mechanic.

    Features


    All the help is provided in the help section of the plug in. Here is a copy of that section:
     

    Code:
    
     ========================================================================
     Help
     ========================================================================
    
     This plugin enables the creation of a achievement system that helps the
     developers to create more in-depth game mechanic. Imagine a game where
     the gamer as to complete a series of tasks to unlock new game modes. To
     unlock new weapons and to access new parts of the game. Imagine you can
     easily create said system and keep track of every task/achievement. The
     limit is your imagination.
    
     ========================================================================
     Plugin Properties
     ========================================================================
    
     Title Text : The name displayed in the top window of the achievements
     menu.
    
     Title Color : The color used to draw the title text of the menu.
    
     Icon Size : The size in pixels used to draw the achievement icon.
    
    
     Achv. Mask Name : The mask name used by achievements if they are no
     unlocked yet. If you don't want to use the mask system use '#' instead.
    
     Achv. Mask Icon : The mask icon & default icon for all the achievements
     locked or unlocked. If you do not want to use the mask use '#' instead.
    
     Achv. Mask Descr. : The general description used for locked achievements
     you can disable the use of the mask by using '#' symbol.
    
    
     The same rules apply for the individual Arch. data. Note whoever that if
     no icon data is supplied the Mask icon is used instead.
    
     Achv. X SwitchId. : This property make the tie between the achievement
     and it's data the system used gameSwitches to lock/unlock achievements.
     This way it is easy to unlock or lock them via the event system.
    
     ========================================================================
     Plugin Commands
     ========================================================================
    
     The plugin command used within this plugin enables the creator to get
     achievement complete rate data and store it inside a gameVariable.
    
     AchievementSys RateToVar X (X is the number of gameVariable).
    
    
     Another couple of plugin commands available are the lock all and unlock
     all commands.
    
     AchievementSys UnlockAll
    
     AchievementSys LockAll
    
    
     Lastly there are a few set of plugin commands for showing/hiding or
     enabling/disabling the MainMenu entry for the achievements menu scene.
    
     AchievementSys MenuShow
    
     AchievementSys MenuHide
    
     AchievementSys MenuEnable
    
     AchievementSys MenuDisable
    
     ========================================================================
     Extra Data
     ========================================================================
    
     XDE.AchievementSys.Params.Data represents an array[26] containing all
     the achievements data [index:0 == null]. Every entry in the array is an
     object containing the following structure.
    
     { switchId: [id], name: [text], iconId: [id], description: [text] }
    
     ========================================================================
     Updates History
     ========================================================================
    
     1.0: Initial Release
     1.1: Corrected a few bugs and added a few more plugin commands
     1.2: Achievements title now can handle escape code text.
    
     ========================================================================
    


    Screenshots
     

    [​IMG]


    [​IMG]


    How to Use
    Put plugin in the plugin folder and add it to your project. The place shouldn't be a problem.


    CALLING THE SCENE
    for now use an event with this java script code:
    SceneManager.push(Scene_Achievement);

    OR

    using Yanfly MainMenuManager:

    a ) choose your menu entry.
    b ) in the name field give a name to your liking ('Achievements') (USE quotation marks here)
    c ) set symbol to 'achievements' (DON'T USE quotation marks here )
    d ) set show & enable to true
    e ) paste this into the Main Bind (DON'T USE quotation marks) : "function( ) { SceneManager.push(Scene_Achievement) }.bind(this);"
    f ) you're ready to go!! :D

    OR (new since v1.1)

    activate auto add in the plugin properties.

    Script


    [Download Plugin Here v1.2]


    Updates
    v1.1 - Added new plugin commands to enable/disable and show/hide main menu entry


            - Added "Auto Add" functionality.


            - Fixed minor bugs and updated code structure.


            - Achievements description can be multiline (just use '\n' character) :)
    v1.1 (NEW) - Corrected a crashing bug! Sorry
    v1.2 Added escape characters capabilities to title window.


    Terms of Usage
    Free to use both on free and commercial games, give credit to author "xDGameStudios" and notify me of your game free or commercial (a demo would be appreciated [​IMG] ).


    Credit and Thanks
    xDGameStudios
     
    Last edited by a moderator: Feb 12, 2016
    #1
    JohnnyR, Name, styx92 and 15 others like this.
  2. Shaz

    Shaz Veteran Veteran

    Messages:
    37,586
    Likes Received:
    11,303
    Location:
    Australia
    First Language:
    English
    Primarily Uses:
    RMMV
    It would be great if you could put the copy of the help section into a spoiler when you post your scripts - some of them are really big and it takes a bit of scrolling to get to the other info.  I've done this for you in at least one of your previous scripts, but I'd love it if you could do the same for this, and future ones :)
     
    #2
    xDGameStudios likes this.
  3. xDGameStudios

    xDGameStudios Veteran Veteran

    Messages:
    102
    Likes Received:
    56
    First Language:
    Portuguese
    Done, sorry
     
    #3
    Shaz likes this.
  4. McSundae

    McSundae Veteran Veteran

    Messages:
    213
    Likes Received:
    218
    Location:
    Germany
    First Language:
    German
    Pretty nice idea and well done :)


    I will definetly use this in the future :D


    Now we just need to know how we can connect those with steam achievements
     
    #4
    Prescott and xDGameStudios like this.
  5. Unmercyful

    Unmercyful Veteran Veteran

    Messages:
    123
    Likes Received:
    30
    First Language:
    English
    This is the second "outside the box" plugin that I have found from you. I have really like your CodeLanguage plugin. Gonna try this one out now. Thanks very much for your hard work on these and sharing :)
     
    #5
    xDGameStudios likes this.
  6. xDGameStudios

    xDGameStudios Veteran Veteran

    Messages:
    102
    Likes Received:
    56
    First Language:
    Portuguese


    Thank you! I'll try to keep them "outside the box" ;)
    Just updated the link, it could get broken but now it's everything ok :D
     
    #6
  7. Myst Desdemona

    Myst Desdemona The Snark Knight Veteran

    Messages:
    69
    Likes Received:
    14
    Location:
    Sweden
    First Language:
    English/Swedish
    Is it possible to tie an ingame reward to an achievement?


    As in you get an item/gold/etc.. for unlocking certain achievements.
     
    #7
    xDGameStudios likes this.
  8. xDGameStudios

    xDGameStudios Veteran Veteran

    Messages:
    102
    Likes Received:
    56
    First Language:
    Portuguese


    You can simply create a parallel event that checks if the gold is over a certain value turn switch X [ON].
    The same way you can create an event that checks for item possession if so turn switch Y [ON].

    Don't forget to turn SelfSwitch ON and change event's page to the second page and delete it. So it isn't such a resource eater.
     
    Last edited by a moderator: Jan 27, 2016
    #8
    Myst Desdemona likes this.
  9. Myst Desdemona

    Myst Desdemona The Snark Knight Veteran

    Messages:
    69
    Likes Received:
    14
    Location:
    Sweden
    First Language:
    English/Swedish
    thank you for the clarification. This would be very useful :)
     
    #9
    xDGameStudios likes this.
  10. xDGameStudios

    xDGameStudios Veteran Veteran

    Messages:
    102
    Likes Received:
    56
    First Language:
    Portuguese


    But keep a look on my plugins!! I might release something of your interest :)  maybe tonight
     
    #10
  11. Myst Desdemona

    Myst Desdemona The Snark Knight Veteran

    Messages:
    69
    Likes Received:
    14
    Location:
    Sweden
    First Language:
    English/Swedish
    I usually keep an eye out for new plugins. Although what interests me the most is a way to create new resources, or at least manipulate the mana/tp bar ( and their colors for each character.)
     
    #11
  12. burntable

    burntable Veteran Veteran

    Messages:
    63
    Likes Received:
    9
    First Language:
    German
    Is it somehow possible to sort the achievements in order they are achieved rather than sorting them by ID?


    Anyhow.. very nice plugin! Thank you!
     
    #12
  13. loozje

    loozje Villager Member

    Messages:
    5
    Likes Received:
    0
    First Language:
    Dutch
    Hi, I have three questions.


    1. How do I unlock a specific achievement? Ego what plugin command would I have to type?


    2. Is it possible to display a pop-up window that tells the player they've completed the achievement?


    3. Is it possible to have more achievements than there currently are? And how would I create them?
     
    #13
  14. Screech1989

    Screech1989 King Pin! Veteran

    Messages:
    107
    Likes Received:
    89
    Location:
    Pontypool, South Wales, UK
    First Language:
    English
    Kinda in the same boat as the guy above? i downloaded your script, added it to the game, the menu is there but no achievements inside there, i have added them based on how i understand your instructions but i still dont see anything in game under achievements its empty, i tried a few methods of calling the achievement so i could just test it, i ltrally made a guy and gave him the call to complete the achievement but nothing i just get an error so im obviously doing something wrong, it could be something simple and stupid?? any ideas?

    what is needed to call the achievement so its complete, and also how do i get them to actually show in the achievements tab when i click it? im so confused right now :S
     
    #14
  15. loozje

    loozje Villager Member

    Messages:
    5
    Likes Received:
    0
    First Language:
    Dutch
     You must fill in the blanks in the achievement mask section and then the individual achievements, both are in the plugin. If you don't want to show anything fill in # and they will show up in the menu. as for how to switch individual achievements between unlock and luck, I still have no idea.
     
    #15
  16. Screech1989

    Screech1989 King Pin! Veteran

    Messages:
    107
    Likes Received:
    89
    Location:
    Pontypool, South Wales, UK
    First Language:
    English
    [EDIT]

    I got it working correctly for anyone stuck :

    Mask Name: ???????
    Mask Icon: #
    Mask Descr.:#

    Achievement Details:
    1 SwitchId : 2001
    1 Name: Learning The Basics
    1 Icon: 476
    1 Descr. : It's Good To Know How To Play

    I then created a Switch i used 2001 as i have so much other stuff and named it correctly :
     #2001 : Achv. 1 SwitchId
    Upon creating the event, or if your adding it to an event you already have, just add anywhere in the event:
    Control Switches : #2001 Achv. 1 SwitchId = ON

    Sorted :D
     
     
    Last edited by a moderator: Feb 11, 2016
    #16
  17. loozje

    loozje Villager Member

    Messages:
    5
    Likes Received:
    0
    First Language:
    Dutch
    Try setting the icon to a number. That seemed to work for me
     
    #17
  18. Screech1989

    Screech1989 King Pin! Veteran

    Messages:
    107
    Likes Received:
    89
    Location:
    Pontypool, South Wales, UK
    First Language:
    English
    It's all sorted now i edited my previous post, thanks for the help tho :D  i had a few little bits wrong basically lol
     
    #18
  19. Ghost of Christmas Kloe

    Ghost of Christmas Kloe Ghost of a Princess Seagull Veteran

    Messages:
    1,504
    Likes Received:
    913
    Location:
    Somewhere...
    First Language:
    English
    Primarily Uses:
    N/A
    This is a really cool plugin! Thanks @xDGameStudios!


    I love the way the achievement menu looks especially, they're all so neatly organised and the big icons next to them looks awesome, especially the achievement ones you use in the screenshot  ;)


    EDIT: Is there any way to have more than 25 achievements? I ran out of space already...


    EDIT2: Also is there a way to use text codes in the title of the achievements menu? THIS ( see below ) doesn't work...

    Capture4.PNG
     
    Last edited by a moderator: Feb 12, 2016
    #19
  20. xDGameStudios

    xDGameStudios Veteran Veteran

    Messages:
    102
    Likes Received:
    56
    First Language:
    Portuguese
    Sorry for my late response somehow I don't receive any notification of your questions --' well hope you all get how to make it work... I thought it would be easy to understand sorry if it isn't xP
    About the 25 achievement limit... I released this plugin as a demo... I intended to make a game of my own and some extra features will remain exclusive...
    I'll be making an update and release an expansion plugin for more a 100 achievements... and will change the title so it can use escape character... keep in mind it won't be centered... anymore... although you can add extra spaces to change that ;)
    See you in a coupe of hours!!
     
     
    #20

Share This Page