1. For downloading SimTools plugins you need a Download Package. Get it with virtual coins that you receive for forum activity or Buy Download Package - We have a zero Spam tolerance so read our forum rules first.

    Buy Now a Download Plan!
  2. Do not try to cheat our system and do not post an unnecessary amount of useless posts only to earn credits here. We have a zero spam tolerance policy and this will cause a ban of your user account. Otherwise we wish you a pleasant stay here! Read the forum rules
  3. We have a few rules which you need to read and accept before posting anything here! Following these rules will keep the forum clean and your stay pleasant. Do not follow these rules can lead to permanent exclusion from this website: Read the forum rules.
    Are you a company? Read our company rules

Tutorial How to write a Game Plugin for SimTools 1.0 - API documentation

Discussion in 'SimTools Plugins' started by yobuddy, Aug 6, 2013.

  1. yobuddy

    yobuddy Well-Known Member Staff Member Moderator SimAxe Beta Tester SimTools Developer Gold Contributor

    Joined:
    Feb 9, 2007
    Messages:
    3,912
    Occupation:
    Computer Technician
    Location:
    Portland, Oregon - USA
    Balance:
    36,434Coins
    Ratings:
    +4,050 / 11 / -0
    @Mpmo,
    Hi Buddy, this may help some too.
    https://www.xsimulator.net/communit...etry-output-into-a-game-simple-example.11080/

    I do agree with @vthinsel thou, sending data using UDP in a fixed structure that can easily be decoded by a SimTools plugin is a good idea.

    Remember thou, in the end it's SimTools that wraps around the game to collect data.
    Meaning you don't have to build the game in a certain way to be compatible with SimTools.
    The Game Plugins can collect data pretty much in any way you wish to send it from the game.
    I guess all I'm saying is there is no limitations on how you wish to export it from the game.

    Anyway, hope it helps!
    Take care,
    yobuddy
    • Like Like x 1
    Last edited: Jun 5, 2018
  2. VR Solutions

    VR Solutions DIY to go!

    Joined:
    Mar 1, 2018
    Messages:
    3
    Location:
    Kuala Lumpur
    Balance:
    - 216Coins
    Ratings:
    +4 / 0 / -0
    My Motion Simulator:
    2DOF, DC motor, Arduino
    Hi. I am trying to develop a plugin for my own boat simulator game development (Unreal Engine 4) . And I have been following all guide provided in this forum for this plugin development. But after so many attempts, I only managed to get the Game Manager & Game Engine GUI turned to BLUE (running) but no output at all in Tuning Center. Any clue on what I possibly missing?
    And I really wonder is the type of license that I purchased (DIY license) got anything to do with the problem I am facing now?
    Thanks in advance.
  3. noorbeast

    noorbeast VR Tassie Devil Staff Member Moderator Race Director

    Joined:
    Jul 13, 2014
    Messages:
    16,773
    Occupation:
    Innovative tech specialist for NGOs
    Location:
    St Helens, Tasmania, Australia
    Balance:
    121,885Coins
    Ratings:
    +9,632 / 47 / -2
    My Motion Simulator:
    3DOF, DC motor, JRK
    The DIY License will not affect motion but can't be used for companion app use, such as Game Vibe, which requires the Pro license.

    For SimTools 2 you should be using this guide instead: https://www.xsimulator.net/communit...lugin-for-simtools-2-0-api-documentation.131/

    And see here for dev resources about adding telemetry to your game: https://www.xsimulator.net/communit...ry-output-into-a-game-unity-and-ue4-code.287/
    • Like Like x 2
  4. Andrew Li

    Andrew Li New Member

    Joined:
    Mar 15, 2019
    Messages:
    1
    Balance:
    50Coins
    Ratings:
    +0 / 0 / -0
    My Motion Simulator:
    Arduino
    Hello @yobuddy ,

    Thank you so much for the tutorial. I downloaded then compile the source code you provided for LFS just to see how it works. However, I am not able to compile the program because of the path error. I try both debug and release mode, but both of them don't work. Could you tell me what's wrong?

    Thanks!

    Attached Files:

  5. yobuddy

    yobuddy Well-Known Member Staff Member Moderator SimAxe Beta Tester SimTools Developer Gold Contributor

    Joined:
    Feb 9, 2007
    Messages:
    3,912
    Occupation:
    Computer Technician
    Location:
    Portland, Oregon - USA
    Balance:
    36,434Coins
    Ratings:
    +4,050 / 11 / -0
    @Andrew Li,
    First buddy, your using the old outdated version, you can get the new version here.
    https://www.xsimulator.net/communit...ugin-for-simtools-2-0-api-documentation.9107/
    All of the info you need to build a plugin is available on this page.

    Please note, that building a plugin loader is against the EULA.
    (So it was not meant to be easy to implement as the SimTools API's are for use only with SimTools.)
    The plugin you compiled thou will work with SimTools v1.
  6. Arta Yasa

    Arta Yasa Member

    Joined:
    Jan 27, 2021
    Messages:
    55
    Balance:
    170Coins
    Ratings:
    +5 / 0 / -0
    My Motion Simulator:
    2DOF
    Hi sir, its simtools 1.3 is free??
    And how about the plugin sir??
    I want to try first for personal, if work and good i want to upgrade to simtools 2.0.
    Because now i dont have money to buy licensi sir, because pandemi kill my work.
    Can someone answer this??
    Please guide me.
  7. noorbeast

    noorbeast VR Tassie Devil Staff Member Moderator Race Director

    Joined:
    Jul 13, 2014
    Messages:
    16,773
    Occupation:
    Innovative tech specialist for NGOs
    Location:
    St Helens, Tasmania, Australia
    Balance:
    121,885Coins
    Ratings:
    +9,632 / 47 / -2
    My Motion Simulator:
    3DOF, DC motor, JRK
    SimTools 1.3 is depreciated and plugins are not maintained for it.

    An eligibility criteria applies, and those that fully meet it can apply for a free SimTools 2 DIY license: https://www.xsimulator.net/community/faq/request-a-free-diy-simtools-2-0-license.262/
  8. paulopsx2

    paulopsx2 Active Member

    Joined:
    Apr 2, 2016
    Messages:
    515
    Location:
    brasil
    Balance:
    286Coins
    Ratings:
    +124 / 0 / -0
    My Motion Simulator:
    2DOF, Arduino, Motion platform
    yes 1.3 stills good. But some plugins dont work with this version. If you cant buy 2.0, how do you do for test plugins, games and motion platforms??
    • Like Like x 1
  9. noorbeast

    noorbeast VR Tassie Devil Staff Member Moderator Race Director

    Joined:
    Jul 13, 2014
    Messages:
    16,773
    Occupation:
    Innovative tech specialist for NGOs
    Location:
    St Helens, Tasmania, Australia
    Balance:
    121,885Coins
    Ratings:
    +9,632 / 47 / -2
    My Motion Simulator:
    3DOF, DC motor, JRK
    The SimToold doiwnload includes the fulkly function plugin for Live For Spoeed, specifically for testing purposes.

    You can buy SimTools directly from the dev if you want to: https://simtools.us/licenses/

    You can also upgrade from the free DIY to Pro SimTools license by logging into SimTools.us. There you will find an upgrade path for a DIY license to Pro for $29.99.
    • Like Like x 1
    • Friendly Friendly x 1
  10. Arta Yasa

    Arta Yasa Member

    Joined:
    Jan 27, 2021
    Messages:
    55
    Balance:
    170Coins
    Ratings:
    +5 / 0 / -0
    My Motion Simulator:
    2DOF
    Yes sir thank you.
    I am going to start making 2 dof, I am still confused about the driving motor, whether I recommend using a motor wiper, or the actuactor as drawn (the actuactor belongs to a parabolic, maybe someone has tried it). or with a pneumatic like the picture, I happen to find a used one, but I want to build 2 dof with little cost. please correct and suggest

    Attached Files:

  11. Arta Yasa

    Arta Yasa Member

    Joined:
    Jan 27, 2021
    Messages:
    55
    Balance:
    170Coins
    Ratings:
    +5 / 0 / -0
    My Motion Simulator:
    2DOF
    How to get DIY licenses sir.? Shold be have 2 dof DIY?? Iam still going to make, now i hqve, seat, Pedals, And wheel, still looking for hollow 4x4cm and motor
  12. noorbeast

    noorbeast VR Tassie Devil Staff Member Moderator Race Director

    Joined:
    Jul 13, 2014
    Messages:
    16,773
    Occupation:
    Innovative tech specialist for NGOs
    Location:
    St Helens, Tasmania, Australia
    Balance:
    121,885Coins
    Ratings:
    +9,632 / 47 / -2
    My Motion Simulator:
    3DOF, DC motor, JRK
    There is an eligibility criteria for a free DIY license: https://www.xsimulator.net/community/faq/request-a-free-diy-simtools-2-0-license.263/

    To qualify for a free license:

    • You must be building a true DIY motion simulator. (Not built from a kit or purchased from a simulator seller, a model simulator does not qualify.)
    • Have a unique build thread or Showcase in DIY Simulator Projects. (The thread should show some effort, which means it should show progress to the rig testing phase.)
    • Have been a member of the community for at least 30 days.
    • Like Like x 1
    • Friendly Friendly x 1
  13. Arta Yasa

    Arta Yasa Member

    Joined:
    Jan 27, 2021
    Messages:
    55
    Balance:
    170Coins
    Ratings:
    +5 / 0 / -0
    My Motion Simulator:
    2DOF
    Alright sir, thank you, i will build first
    • Like Like x 1
  14. paulopsx2

    paulopsx2 Active Member

    Joined:
    Apr 2, 2016
    Messages:
    515
    Location:
    brasil
    Balance:
    286Coins
    Ratings:
    +124 / 0 / -0
    My Motion Simulator:
    2DOF, Arduino, Motion platform
    well. if you do this for the first time, i recomend wipers, 24v, 500watts, 300 more rpm. and use arduino, motomonster for controller. simples, excelent results, and not expensive.
    • Friendly Friendly x 1
  15. Arta Yasa

    Arta Yasa Member

    Joined:
    Jan 27, 2021
    Messages:
    55
    Balance:
    170Coins
    Ratings:
    +5 / 0 / -0
    My Motion Simulator:
    2DOF
    My be i want to use wipper motor bus sir, its oke or recomend?? Because i want buy second sir