Home / Edit Creating Workshop Items

Log in to edit

Creating Workshop Items

<cat>code.workshop</cat>
<title>Creating Workshop Items</title>

# Creating An Item

Creating an item is pretty straight forward.

```
var result = await Ugc.Editor.NewCommunityFile
					.WithTitle( "My New Item" )
					.WithDescription( itemDescription )
					.WithTag( "Map" )
					.SubmitAsync();
```

# Uploading An Item

The previous example doesn't include any files with the item. To do that we use <page>Ugc.Editor.WithContent</page>.

This will upload the contents of that folder as your entry.

```
var result = await Ugc.Editor.NewCommunityFile
					.WithTitle( "My New Item" )
					.WithDescription( itemDescription )
					.WithTag( "Map" )
					.WithContent( pathToFolder )
					.SubmitAsync();
```

# Showing Progress 


The submit function <page>Ugc.Editor.SubmitAsync</page> takes an optional parameter of a IProgress<float>.

You should be able to use this to show some progress.


```

class ProgressClass : IProgress<float>
{
	float lastvalue = 0;

	public void Report( float value )
	{
		if ( lastvalue >= value ) return;

		lastvalue = value;

		Console.WriteLine( value );
	}
}

...

var result = await Ugc.Editor.NewCommunityFile
					.WithTitle( "My New Item" )
					.WithDescription( itemDescription )
					.WithTag( "Map" )
					.WithContent( pathToFolder )
					.SubmitAsync( new ProgressClass() );
```

Facepunch.Steamworks Wiki

Facepunch.Steamworks

Getting Started 3

Installing 1

Installing For Unity

Dedicated Servers 1

Server Library

Api Documentation

Interfaces 23

Classes & Structs 58

Achievement
- Description
- GlobalUnlocked
- Identifier
- Name
- State
- UnlockTime
- Clear
- GetIcon
- GetIconAsync
- Trigger
Amount
- Item
- Quantity
AnalogState
- EMode
- X
- Y
- Active
AppId
- Value
AuthTicket
- Data
- Handle
- Cancel
- Dispose
Color
- a
- b
- g
- r
Connection
- ConnectionName
- Id
- UserData
- Accept
- Close
- DetailedStatus
- Flush
- SendMessage
ConnectionInfo
- Address
- EndReason
- Identity
- State
ConnectionManager
Controller
DepotId
- Value
DigitalState
- Active
- Pressed
Dispatch
- OnDebugCallback
- OnException
DlcInformation
- AppId
- Available
- Name
DownloadProgress
DurationControl
- Appid
- Applicable
FileDetails
- Flags
- Sha1
- SizeInBytes
Friend
FriendGameInfo
GameId
- Value
IConnectionManager
Image
- Data
- Height
- Width
- GetPixel
Ingredient
InventoryDef
InventoryDefId
- Value
InventoryItem
- Acquired
- Def
- DefId
- Id
- IsConsumed
- IsNoTrade
- IsRemoved
- Origin
- Properties
- Quantity
- AddAsync
- ConsumeAsync
- SplitStackAsync
InventoryItemId
- Value
InventoryPurchaseResult
- OrderID
- Result
- TransID
InventoryRecipe
InventoryResult
- Expired
- ItemCount
- BelongsTo
- Dispose
- GetItems
- Serialize
ISocketManager
Leaderboard
LeaderboardEntry
- Details
- GlobalRank
- Score
- User
LeaderboardUpdate
Lobby
- Data
- Id
- MaxMembers
- MemberCount
- Members
- Owner
- DeleteData
- GetData
- GetGameServer
- GetMemberData
- InviteFriend
- IsOwnedBy
- Join
- Leave
- Refresh
- SendChatString
- SetData
- SetFriendsOnly
- SetGameServer
- SetInvisible
- SetJoinable
- SetMemberData
- SetPrivate
- SetPublic
LobbyQuery
NetAddress
- Cleared
- AnyIp
- From
- LocalHost
- Address
- IsIPv4
- IsIPv6AllZeros
- IsLocalHost
- Port
NetIdentity
- LocalHost
- Address
- IsIpAddress
- IsLocalHost
- IsSteamId
- SteamId
NetPingLocation
- TryParseFromString
- EstimatePingTo
OutgoingPacket
- Address
- Data
- Port
- Size
P2Packet
- Data
- SteamId
PartyBeacon
PublishedFileId
- Value
RemotePlaySession
- ClientName
- FormFactor
- Id
- IsValid
- SteamId
Screenshot
ServerInfo
- Address
- AddressRaw
- AppId
- BotPlayers
- ConnectionPort
- Description
- GameDir
- LastTimePlayed
- Map
- MaxPlayers
- Name
- Passworded
- Ping
- Players
- QueryPort
- Secure
- SteamId
- Tags
- TagString
- Version
- AddToFavourites
- AddToHistory
- QueryRulesAsync
- RemoveFromFavourites
- RemoveFromHistory
ServerList
- Base
- Favourites
- Friends
- History
- Internet
- IpList
  - Ips
  - OnChanges
  - OnResponsiveServer
  - Responsive
  - Unresponsive
  - AppId
  - AddFilter
  - Cancel
  - Dispose
  - RunQueryAsync
  - UpdateResponsive
- LocalNetwork
Socket
- Manager
- Close
SocketManager
- Connected
- Connecting
- Interface
- Socket
- Close
- OnConnected
- OnConnecting
- OnConnectionChanged
- OnDisconnected
- OnMessage
- Receive
Stat
- Name
- UserId
- Add
- GetFloat
- GetGlobalFloat
- GetGlobalFloatDays
- GetGlobalInt
- GetGlobalIntDaysAsync
- GetInt
- Set
- Store
- UpdateAverageRate
SteamId
- Value
- AccountId
- IsValid
SteamServerInit
Ugc
Utility
SteamClass
SteamClientClass
SteamServerClass
SteamSharedClass

Enums 30

Code Snippets

General 4

Friends 1

Grouping Friends

Inventory 1

Item Store Cart

Servers 1

Get Server List

Workshop 3

Stats & Achievements 4

Networking 2

Unity Specific 1

Getting A Client's Avatar