sso-elements-fmk 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a1557cd39c57399cb8864bd05d13a42b08a13be5815cdd8d6b136d09ba765108
-  data.tar.gz: 3531bf8d59858c74d1e1378a0c2c48516b281adb957a2b49a15e0deb9aff06a4
+  metadata.gz: a2c4d8e727e906f0f3796714afd8e6a62fa3d8666ef8412bd0b4ba918f600d44
+  data.tar.gz: 85b2ba159a66bbffee1b2e391a019f66302be1a85463fc233e25f2592e3f8dda
 SHA512:
-  metadata.gz: ea03d916aedfc30c1504f9e67bbaa11074e1765530737fbdf8145873e43559df01ae2b56d1ee5f7422719aa24da544068d0ca1539672b1eb7b1094db35545dc9
-  data.tar.gz: 4e56abeac32ab6b3164fd167b216cfd72a35eb69f0152575c2e9a817502a1703b5ad7676d5d8b5bce23247f09dc4aeab8aa56a35b5ced9eba1274988130235bb
+  metadata.gz: 56aea11df641f1933a8e4aa6f0dae027c75e80529c63ab624fe7d31cfa3ab2ac21dfa28e49ddead894b0c446a942753e2ec546af02d9289c14faf9283bd898be
+  data.tar.gz: 5cb949760e78bfb7289e9123d5bd8839d7b416de20e4f7b90af137cc49d097c3899ff918ba36903f749466bdc77fb71778aba6a8c90173bbbebedb245203eb7c

data/README.md

@@ -1,24 +1,58 @@
 # SSO::Elements::Fmk
 
-TODO: Delete this and the text below, and describe your gem
-
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/sso/elements/fmk`. To experiment with that code, run `bin/console` for an interactive prompt.
+Simple SSO elements editor for Ruby
 
 ## Installation
 
-TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
-
 Install the gem and add to the application's Gemfile by executing:
 
-    $ bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+    $ bundle add sso-elements-fmk
 
 If bundler is not being used to manage dependencies, install the gem by executing:
 
-    $ gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+    $ gem install sso-elements-fmk
 
 ## Usage
 
-TODO: Write usage instructions here
+Here you can see a basic sample of how to create an NPC
+
+```ruby
+require 'sso/elements/fmk'
+
+# Creates a new collection
+collection = SSO::Elements::Collection.new
+
+# Loads a custom config
+collection.load_config!(150)
+
+# Load all elements from file
+collection.load_elements!('./lib/sso/elements/samples/elements.data')
+
+# Gets Npc Essence table
+npc_essence = collection.table('NpcEssence')
+
+# Gets a random NPC
+some_random_npc = npc_essence.find_element_by_id 4850
+
+# Clones the npc into a new one
+npc = some_random_npc.clone
+
+# Set new npc custom properties
+npc.id = 120031
+npc.name = 'Donovan'
+npc.item_exchange_service = 0
+npc.file_model = 2023
+npc.file_icon = 4713
+npc.name_prof_prefix = 'Just someone'
+
+# Adds the new npc to the collection
+npc_essence.add_element(npc)
+
+# Persists elements into a new file
+collection.save!('./lib/sso/elements/samples/new_elements.data')
+```
+
+More samples can be found [here](https://github.com/kuroro7/sso-elements-fmk/tree/master/examples)
 
 ## Development
 
@@ -28,11 +62,11 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/sso-elements-fmk. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/sso-elements-fmk/blob/master/CODE_OF_CONDUCT.md).
+Bug reports and pull requests are welcome on GitHub at https://github.com/kuroro7/sso-elements-fmk. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/sso-elements-fmk/blob/master/CODE_OF_CONDUCT.md).
 
 ## License
 
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+The gem is available as open source under the terms of the [LGPL License](https://www.gnu.org/licenses/lgpl-3.0.txt).
 
 ## Code of Conduct
 

data/examples/npc_creation.rb

@@ -0,0 +1,33 @@
+require 'sso/elements/fmk'
+
+# Creates a new collection
+collection = SSO::Elements::Collection.new
+
+# Loads a custom config
+collection.load_config!(150)
+
+# Load all elements from file
+collection.load_elements!('./lib/sso/elements/samples/elements.data')
+
+# Gets Npc Essence table
+npc_essence = collection.table('NpcEssence')
+
+# Gets a random NPC
+some_random_npc = npc_essence.find_element_by_id 4850
+
+# Clones the npc into a new one
+npc = some_random_npc.clone
+
+# Set new npc custom properties
+npc.id = 120031
+npc.name = 'Donovan'
+npc.item_exchange_service = 0
+npc.file_model = 2023
+npc.file_icon = 4713
+npc.name_prof_prefix = 'Just someone'
+
+# Adds the new npc to the collection
+npc_essence.add_element(npc)
+
+# Persists elements into a new file
+collection.save!('./lib/sso/elements/samples/new_elements.data')

data/lib/sso/elements/fmk/version.rb

@@ -3,7 +3,7 @@
 module SSO
   module Elements
     module Fmk
-      VERSION = "0.1.1"
+      VERSION = "0.1.2"
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sso-elements-fmk
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - kuroro
@@ -25,6 +25,7 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- examples/npc_creation.rb
 - lib/sso/elements/collection.rb
 - lib/sso/elements/config.rb
 - lib/sso/elements/configs/PW_1.0.2_v150.cfg