[ABD] Store MOD (formerly wGEric Store MOD for phpBB2)

[Rizzn.]

• || Demo Site will be up soon ||
  
  
  Requirements
• This MOD will require that you have either Handyman's Cash MOD or Ganon_master's Simple Points System successfully installed and working on your site prior to installation of Store MOD. Alternatively, Store MOD will include a version of a Points System in the contrib folder should the installing admin not have one of the aforementioned modifications.
  Should either of these two MODs stop in development and fail to reach the MODDB, we will attempt to find a new currency MOD to integrate with Store MOD that will be approved for the MODDB. Hopefully their respective developers will continue on these projects.
• It is suggested that any other shop/store MOD out there is not installed on your board and all traces of a previous install removed. Since we have neither experimented with nor even downloaded the few others in development, we have no way of knowing whether or not there will be conflicts and resolving such conflicts can be quite difficult.
  
  
  Features in development for initial beta version
  ADMINISTRATION CONTROL PANEL
  Item/Item Type and Store/District management has been significantly altered from the phpBB2 version of Store MOD. Each now functions similarly to the the forum/category system in phpBB3, allowing for nested subdistricts as well as inherited permissions and other features.
• All Admin actions are logged into the Store Log similarly to the way other logs are maintained.
  
  Cash/Points Usage
• Admins can select which MOD is used in conjunction with the Store MOD.
• If the Cash MOD is
  
  Districts and Stores
• Admins have full control over both user owned and board owned stores and their inventories as well as individual users' inventories and may add/edit/delete/move items in them.
  - Board owned stores can be set to be automatically restocked or set to "infinite" so that they never run out of stock.
  - Admins may limit the maximum number of stores a single user can own
  - Board owned stores may have custom store owner names.
• Shopping Districts may be created in which users may create their own stores.
  - A "creation price" can be set that a user is required to pay before being permitted to create a store in the district.
  - Districts and stores may have an unlimited number of subdistricts and substores under them.
  - Admins can limit the maximum number of stores allowed in each district and can also limit the maximum number of stores an individual user or user group is permitted.
  
  Items and Item Types
• Admins can create various Item Types for organizing items.
  - Three basic Types which can't be deleted but can be edited are "General Items," "Downloadable Items," and "Special Items."
  • General Items - otherwise uncategorized items
  • Downloadable Items - may have files attached which can then be downloaded by the item's owner
  • Special Items - When the Store MOD is configured to disable the sale of Special Items, users are not allowed to place items in the Special Item group nor any other group marked as "special" into their stores and any special items already in their stores are automatically returned to their inventories.
  - Admins can create an unlimited number of Item Types and Subtypes that can be marked as either "general" or "special" for the purposes of selling special items; however, only the default "Downloadable Items" can support downloads.
• Usable Items - Items marked as either "general" or "special" may have associated php files that are executed when a user clicks the "Use Item" link in his inventory. This system works exactly as in the phpBB2 version of Store MOD.
• Items can be made to 'expire' after a preset period of time with each item able to have its own custom expiration message.
• Items can have an individual tax rate that an admin can mark as either "Additional" or "Replacement." An additional tax is added to any district and global tax already charged on the item, but a replacement tax simply replaces the amount of tax that is normally charged with that rate. Replacement taxes are especially useful for "tax exempt" items by setting the individual item tax rate to 0%.
  
  MAIN BOARD
  Stores and Inventories
• Users can create their own stores in which to sell items from their inventory
  - Users can own as many stores as their wish and is permitted by board settings
  - If Cash MOD is used, users choose the currency for their store from the list of enabled currencies
• Users can manage and delete their stores and items in their stores and personal inventory
  
  Buying/Selling Items
• Users may purchase multiple items simultaneously from a single store using a "shopping cart" like feature with a Checkout Screen to show total costs including any taxes.
• PM sent to store owner when an item is sold or to the specified user (usually an admin) when an item is sold in a Board Owned Store.
• Users can trade items and cash with other users. (Might not be in early Beta releases)
• Stores can be searched allowing users to quickly find the items they want to purchase (Might not be in early Beta releases)
  
  
  Road Map for after initial Beta
• Sell Items to Board Stores -
  Users can sell items they own back to board owned stores.
  • Realistic Price Variance
    Prices of items in board stores can be set to allow price variations based on the amount of bought and sold items. Items that are purchased by users more often will steadily increase in price while items that are seldom purchased will slowly decrease in price. This will simulate a slightly more realistic economy.
    Note: This feature may be implemented as a separate MOD or addition in the contrib folder
• Store Rental Fees (per district) -
  Store owners are required to pay a rental fee (set in ACP) to run their store.
• Auction House -
  Auction house where any user can put any item up for open auction.
  Note: This feature may be implemented as a separate MOD or addition in the contrib folder
• Logging Actions(?) -
  Logging of all actions in the Store MOD. Logs accessible via ACP.
  Note: This feature may or may not be implemented at all. Logging every action could potentially get out of hand in size.
  
  Feel free to request additional features

[MewDragon]

Hey Rizzn.

You have no idea how happy I was to see this thread. I've been waiting for this to be ported. ^^ I actually used both WGEric's store mod and Zarath's shop mod for my various phpbb 2.0.x forums, so I'm pretty familiar with how they work. My forum members are really excited about a new shop/store system for 3.0, and we came up with a feature list. I'm reasonably confident that most of the features we thought of can be added into the store mod. Plus the store mod is such an awesome mod, and it deserves to be as awesome as possible. xP

Anyway, here's what we've got.




Feature List:

- first and foremost the store mod should be an option editable in the permission roles section. So basically, you can assign various users/moderators/administrators to be able to help work on the shop mod. After all, when you're dealing with hundreds of items being needed to be uploaded and added and managed into the shops, you really need some help from some other people. But at the same time, don't want to give them access to all of the admin panel. Since roles are now a part of phpbb, it seems like the perfect thing for the store mod.

- be able to organize items into collectible sets.
- be able to sell treasure boxes/goody bags where when you open them, you get multiple items, certain % chance of getting items, perhaps have it so that in the admin panel you can specify which items are possible for being in the goody bag.
- can give certain users/user groups items.
- limit total number of items that can be in existence.
- trade items with other members.
- limit the total number of items a user can have for sale in his shop.

- when a user opens up a new shop, they basically start a business.
- must pay a creation price for opening a new shop.
- user's can sell items currently in their inventory, and determine the price of the item.
- user's can also purchase a "creation" option which is part of the user shop system.

• - includes an upload utility for images.
  - user can create new items.
  - creation option costs certain amount to purchase.
  - items that user's create are subject to a tax upon creation.
  - all items sold in user's shop are subject to a sales tax based upon the price of the item.
  - various tax rates are set up in the admin panel.

- User can also sell "shares" in his business.
- User can change the percentage investor's have on the return of their shares.
- Investors receive a certain percentage, based upon their shares, on a regular amount of time which is a setting.
- Investors also receive a discount on items sold in user's shop.
- If business is doing poorly, user can default and declare bankruptcy, his items will be seized and distributed among investors (investors can choose between having their portion be in coin or in items retrieved from business) Perhaps have something like the user cannot create another business for a certain period of time.
- Investors cannot own the business they invest in.


- user's shops/businesses are displayed on a ranking page of sorts. Basically the more popular/higher sales your shop has, the higher your ranking on the page.


- user's shops can grow into bigger shops, there are different levels of shops. (perhaps 3 at most? or could it be definable in the admin panel?)

hopefully you've played animal crossing, because I'm thinking of basically the way Nook's shop grows after a certain amount of money is passed through Nook's shop, either by items being bought or sold.

- so basically what would happen is the system would log all of your transactions, primarily sales, and after a certain amount was sold, your store would essentially level up. You could name the different levels in the admin panel.
- leveling up would allow you to hold more items in your shop for sale, and it would also place you at a higher ranking on the rankings page then other shop owner's who's shop was at a lower level than yours.


--------------------------------------------------------------------------


We also had a feature list for the Auctions as well.



The Browse Panel:

• - there you can see all current auctions in the auctions house
  - select a specific item
  - Bid or buyout the item you want

The Your Bids Panel:

• - there you will see all auctions you already have bidded on
  - You will see there as well once you got outbid
  - Bid/Buyout option is on this panel as well

The Your Auctions Panel:

• - create/cancel your auctions
  - Set a starting price, the duration (max 72 hours) and pay the deposit
  - deposit will be calculated right as soon you type in your price and duration (using javascript for this)

The Mail (Private Message), points and item system:

• - If one of your auctions expires (no bids), you will get a PM and your deposit back
  - As soon another player buyouts your auction you will get a PM and the points and the item will be transfered to the winner
  - As soon someone outbids you on an item you will get a PM and your points back
  - As soon a auction expires that you have won you will get a PM and the item
  - As soon another player cancels an auction you were interested in, you will get a PM and your points back

How is the deposit and next high bid calculated ?- Deposit = starting price * 0.002 * auction duration (rounded up with ceil)
- Next High Bid if bid placed = current_bid + (current_bid * 0.002) (rounded up with ceil)
- Next High Bid if no bid placed = starting price + (starting price * 0.002) (rounded up with ceil)
Incase you want to change the ratio, change all 0.002 in adr_auction.php
and adr_auction_body.tpl (java function) to whatever you want.
That basically means, the higher the starting price and duration, the higher
will deposit.
The higher the starting price, the higher will be the increment of bids

How bidding/buyout works:

• - you can't bid on your own auctions
  - you can't bid if you don't have enough cash
  - you can't buyout an item if the current bid is already higher/equal the buyout price
  - you can't buyout your own auctions

Also, everytime someone visits the auction house, it checks first for expired auctions and does all the cash and item transfers.
In other words, this auction house works fully automatical, you don't have to worry and wait for payments like in other auction house systems.
Nobody can bid if he doesn't have the cash, his bid will be removed of his points and will be saved in the database.


Also perhaps some kinda feedback system, similar to the one on ebay.

[Rizzn.]

Glad to hear at least one person is psyched up about it. I always just worked on the Store MOD because I used it. I wasn't really all that sure anyone else did.

Edit: After posting, I realized that I referred to the different versions of the Store MOD by the monikers of "v2" and "v3." These are what Prizem and I call the different versions from a development standpoint, so it kind of carried over into this post. Rather than rewriting the entire post, I'll just say here that when I say "v2," I mean "wGEric Store MOD for phpBB2," and when I say "v3," I am referring to "Store MOD for phpBB3."

Feature List:

- first and foremost the store mod should be an option editable in the permission roles section. So basically, you can assign various users/moderators/administrators to be able to help work on the shop mod. After all, when you're dealing with hundreds of items being needed to be uploaded and added and managed into the shops, you really need some help from some other people. But at the same time, don't want to give them access to all of the admin panel. Since roles are now a part of phpbb, it seems like the perfect thing for the store mod.

Already have this implemented in the current v3 code. I don't have all the permissions setup yet, but I've got the majority of them already coded in and working.

- be able to organize items into collectible sets.

That's what the "Item Types" are for, unless you mean some sort of "display album" or something.

- be able to sell treasure boxes/goody bags where when you open them, you get multiple items, certain % chance of getting items, perhaps have it so that in the admin panel you can specify which items are possible for being in the goody bag.

That would be a feature for a Usable Item not a core MOD feature. I believe we had an item similar to this on our support site that was called a Booster Pack or something.

- can give certain users/user groups items.

Already available via standard inventory administration; however, I can look into adding a feature to give an item to all members in a specific user group.

- trade items with other members.

Already in v2 and on the list for v3.

- limit total number of items that can be in existence.
- limit the total number of items a user can have for sale in his shop.

Both good suggestions. I'll add those to my road map, but I'm probably not going to have them in the first few betas. I'm working on getting the preexisting features ported over first.

- when a user opens up a new shop, they basically start a business.
- must pay a creation price for opening a new shop.
- user's can sell items currently in their inventory, and determine the price of the item.
- user's can also purchase a "creation" option which is part of the user shop system.

All already implemented in v2 and carried over to v3.

• - includes an upload utility for images.

Users can easily use the Attachment feature already built into phpBB3 to upload images. I don't really see a need for adding an additional upload feature for the Store MOD.

- user can create new items.

Being ported from v2.

- creation option costs certain amount to purchase.

I can definitely add this to the road map.

- items that user's create are subject to a tax upon creation.
- all items sold in user's shop are subject to a sales tax based upon the price of the item.
- various tax rates are set up in the admin panel.[/list]

All already implemented in v2 and porting to v3. Taxes are already somewhat detailed in my original post.

- User can also sell "shares" in his business.
- User can change the percentage investor's have on the return of their shares.
- Investors receive a certain percentage, based upon their shares, on a regular amount of time which is a setting.
- Investors also receive a discount on items sold in user's shop.
- If business is doing poorly, user can default and declare bankruptcy, his items will be seized and distributed among investors (investors can choose between having their portion be in coin or in items retrieved from business) Perhaps have something like the user cannot create another business for a certain period of time.
- Investors cannot own the business they invest in.

A stock market feature is probably best left to another MOD. I may look into starting such a MOD once I get the Store MOD well underway, but I'm going to hold off on that for now. If someone else wants to take up that MOD, I'll be glad to work with them on integrating it with the Store MOD.

- user's shops/businesses are displayed on a ranking page of sorts. Basically the more popular/higher sales your shop has, the higher your ranking on the page.

- user's shops can grow into bigger shops, there are different levels of shops. (perhaps 3 at most? or could it be definable in the admin panel?)

hopefully you've played animal crossing, because I'm thinking of basically the way Nook's shop grows after a certain amount of money is passed through Nook's shop, either by items being bought or sold.

- so basically what would happen is the system would log all of your transactions, primarily sales, and after a certain amount was sold, your store would essentially level up. You could name the different levels in the admin panel.
- leveling up would allow you to hold more items in your shop for sale, and it would also place you at a higher ranking on the rankings page then other shop owner's who's shop was at a lower level than yours.

Actually, no, I haven't played Animal Crossing.

This suggestion means that new members are going to be on the bottom of the list and have a hard time working their way up. Currently, stores can be sorted by number of items for sale, alphabetically by name, and by Store ID, which is essentially creation date or age of the store. I'll think about this, but at this time, I'm going to have to say probably not.

We also had a feature list for the Auctions as well.

...

That's all pretty much what I have in mind for the Auction system, and more or less what I had underway for v2 before phpBB3 came out. For now though, I'm actually going to be working on the core of the Store MOD. Once that is taken care of, I'll get back to addressing an auction system.

[Exorcizer]

Yes! I've been waiting for this mod too! Glad to see there's development on it!

I agree with all your features and those above.

The only thing I'd like to add is a way for users to buy special features of the board such as Signature Privileges, Avatar Privilege, Custom User Title, Custom Username color/glow/shadow and so on... Pretty much like Thoul's Effect Shop if you ever took a look at it

EDIT: And I just rem embed some great mod I used to have on my phpBB2 forums (I switched to MyBB to wait for phpBB3 to come out, but now... I just can't take MyBB anymore, phpBB3 is so great!) It was a "Synthesize Shop" where users had the ability to fuse items together and make a new one (if possible).

Anyways, good luck, and keep us updated on this!

[Rizzn.]

The only thing I'd like to add is a way for users to buy special features of the board such as Signature Privileges, Avatar Privilege, Custom User Title, Custom Username color/glow/shadow and so on... Pretty much like Thoul's Effect Shop if you ever took a look at it

Actually, we had usable items that did this in the phpBB2 version. We didn't actually create the items, as they were user submitted, but they did exist. If we don't get around to making these items before the initial release, I'm sure a user probably will.

EDIT: And I just rem embed some great mod I used to have on my phpBB2 forums (I switched to MyBB to wait for phpBB3 to come out, but now... I just can't take MyBB anymore, phpBB3 is so great!) It was a "Synthesize Shop" where users had the ability to fuse items together and make a new one (if possible).

Anyways, good luck, and keep us updated on this!

The synth shop was actually for Zarath's MOD, not this one. Though to be honest, that functionality is pretty easily added via the usable items system. If you just want to code up an admin interface and hack the Store MOD to add this and do it the hard way, that's your decision. *looks around quickly then leans in to whisper* Don't tell anyone this, but... I've actually got a crafting system thing in the planning stages as a pet project once the Store MOD gets underway. It'll be implemented entirely through the usable items interface and not require any file edits. Mostly, I'll be doing it as an example to show just how flexible the usable items system really is in comparison to the traditional "Let's make a new MOD to this other MOD that is a modification to that first MOD to get the functionality we need" approach.

[MewDragon]

Fantastic. ^.^ This is gonna be so much pwnage. I can't wait for it to be done.

Mods like this make me want to be able to make mods.

The useable items scripts sound great.

[Rizzn.]

Eh, if you just want to play around with the feature set, you can always use the current version (in the other thread) on a phpBB2 install. We're rewriting most of the code, but the feature set (at this point) is almost a direct port.

[rickyschuijff]

yea great news to read

[kiran_n444]

Hows bout Pay Per Attachment?
Users need to "pay" a certain price to download an attachment. That seems nice and will help prevent leechers. because i'm not into the HideHack. Thnx in advance.

[Rizzn.]

Hows bout Pay Per Attachment?
Users need to "pay" a certain price to download an attachment. That seems nice and will help prevent leechers. because i'm not into the HideHack. Thnx in advance.

Yes, that's the point of Downloadable Items.

[Gleasonator]

This is awesome! I can't wait!

[Exorcizer]

Thanks for the response!

I'll be looking forward to test it out!

[Prizem]

It's good to see a nice reception to the new development =D

[rickyschuijff]

how far is the development?

[MewDragon]

Given that this topic was only put up last saturday, I doubt that progress is all that far along. Rizzn'll let us know though when he's gotten a bit farther along.