jamiephan/README.md

## README.md

      
    Raw
  

              README.md
            
          
    Script to add all items from quixel

As quixel is being removed, all items are free to aquire. This script is to automate the process to add items to your account (As of writing, a total of 18874 items)

Note: This script only tested in the latest version of Chrome.

How to use


Copy the script from below (run.js)
Login into https://quixel.com
Go to https://quixel.com/megascans/collections
Open devtools (F12) -> Go to "Console" tab
Paste in the script and press Enter.
A dialog should popup confirming the execution, click "OK"
Sit back and wait

Common issues


Getting "Forbidden" error. (Even after refresh, the whole page just shows "Forbidden")

There is a chance that the API adding too fast and you hit the rate limit of the API. (My testing is around after 10 pages, so ~10k items).
Wait after ~10-20 minutes and continue. See Common Fixes -> Restart script to continue the execution after you can load https://quixel.com.


The script seems to be paused/hang

It could be too much logging going it. Try monitor the script, if it says "END PAGE X", note the page number down (in case need restart) and clear the console by clicking the "🚫" icon in devtools.
See Common Fixes -> Restart script for fixing.


Getting the error **UNABLE TO ADD ITEM**

There should have the error message shown in ( ). If it is user already owns specified asset at a higher or equal resolution, then its already in your account.


Getting the error cannot find authentication token. Please login again

Clear browser cookies and re-login quixel again. Try just simply add 1 item manully. If it success, then see Common Fixes -> Restart script for continue the execution.


Common Fixes

Restart Script


Note which page it was running
Copy the run.js script
Update the startPage = 0 on the first line to startPage = 10 (assuming page 10 was hanged)

Change Log


Initial Script launch
Update to clear logs to reduce chance of hanging
[CURRENT] Skip adding items that already was acquired. Reduced logs. Added more info after script completion to show purchased item count. Due to now skipping purchased items, you technically don't need to specify the startPage anymore.


## run.js
((async (startPage = 0, autoClearConsole = true) => {

  const getCookie = (name) => {
    const value = `; ${document.cookie}`;
    const parts = value.split(`; ${name}=`);
    if (parts.length === 2) return parts.pop().split(';').shift();
  }

  const callCacheApi = async (params = {}) => {
    const defaultParams = {
      page: 0,
      maxValuesPerFacet: 1000,
      hitsPerPage: 1000,
      attributesToRetrieve: ["id", "name"].join(",")
    }
    const response = await fetch("https://proxy-algolia-prod.quixel.com/algolia/cache", {
      "headers": {
        "x-api-key": "2Zg8!d2WAHIUW?pCO28cVjfOt9seOWPx@2j"
      },
      "body": JSON.stringify({
        url: "https://6UJ1I5A072-2.algolianet.com/1/indexes/assets/query?x-algolia-application-id=6UJ1I5A072&x-algolia-api-key=e93907f4f65fb1d9f813957bdc344892",
        params: new URLSearchParams({ ...defaultParams, ...params }).toString()
      }),
      "method": "POST",
    })
    return await response.json()
  }

  const callAcl = async ({ id, name }) => {
    const response = await fetch("https://quixel.com/v1/acl", {
      "headers": {
        "authorization": "Bearer " + authToken,
        "content-type": "application/json;charset=UTF-8",
      },
      "body": JSON.stringify({ assetID: id }),
      "method": "POST",
    });
    const json = await response.json()
    if (json?.isError) {
      console.error(`  --> **UNABLE TO ADD ITEM** Item ${id} | ${name} (${json?.msg})`)
    } else {
      console.log(`  --> ADDED ITEM Item ${id} | ${name}`)
    }
  }

  const callAcquired = async () => {
    const response = await fetch("https://quixel.com/v1/assets/acquired", {
      "headers": {
        "authorization": "Bearer " + authToken,
        "content-type": "application/json;charset=UTF-8",
      },
      "method": "GET",
    });
    return await response.json()
  }

  // 1. Check token exist, quixel API needs it
  console.log("-> Checking Auth API Token...")
  let authToken = ""
  try {
    const authCookie = getCookie("auth") ?? "{}"
    authToken = JSON.parse(decodeURIComponent(authCookie))?.token
    if (!authToken) {
      return console.error("-> Error: cannot find authentication token. Please login again.")
    }
  } catch (_) {
    return console.error("-> Error: cannot find authentication token. Please login again.")
  }

  // 2. Get all currently acquired items
  console.log("-> Get Acquired Items...")
  const acquiredItems = (await callAcquired()).map(a => a.assetID)

  // 3. Get total count of items
  console.log("-> Getting Total Number of Pages....")
  const { nbPages: totalPages, hitsPerPage: itemsPerPage, nbHits: totalItems } = await callCacheApi()


  console.log("-> ==============================================")
  console.log(`-> Total # of items: ${totalItems}`)
  console.log(`-> ${totalPages} total pages with ${itemsPerPage} per page`)
  console.log(`-> Total Items to add: ${(totalItems - acquiredItems.length)}.`)
  console.log("-> ==============================================")

  if (!confirm(`Click OK to start adding ${(totalItems - acquiredItems.length)} items in your account.`)) return

  // Loop
  for (let pageIdx = startPage || 0; pageIdx < totalPages; pageIdx++) {
    console.log(`-> ======================= PAGE ${pageIdx + 1}/${totalPages} START =======================`)

    console.log("-> Getting Items from page " + (pageIdx + 1) + " ...")

    const { hits: items } = await callCacheApi({ page: pageIdx })

    console.log("-> Adding non-acquired items...")

    // Filter out owned items
    const unownedItems = items.filter(i => !acquiredItems.includes(i.id))
    const aclPromises = unownedItems.map(callAcl)

    await Promise.all(aclPromises)
    console.log(`-> ======================= PAGE ${pageIdx + 1}/${totalPages} COMPLETED =======================`)
    if (autoClearConsole) console.clear() // Fix the issue that too much log hangs the console. Set autoClearConsole = false to keep the logs
  }

  console.log("-> Getting new acquired info...")
  // Get acquired items again
  const newItemsAcquired = (await callAcquired()).length
  const newTotalCount = (await callCacheApi()).nbHits

  console.log(`-> Completed. Your account now have a total of ${newItemsAcquired} out of ${newTotalCount} items.`)

  alert(`-> Your account now have a total of ${newItemsAcquired} out of ${newTotalCount} items.\n\nIf you find some items missing, try refresh the page and run the script again.`)
})())
	((async (startPage = 0, autoClearConsole = true) => {

	const getCookie = (name) => {
	const value = `; ${document.cookie}`;
	const parts = value.split(`; ${name}=`);
	if (parts.length === 2) return parts.pop().split(';').shift();
	}

	const callCacheApi = async (params = {}) => {
	const defaultParams = {
	page: 0,
	maxValuesPerFacet: 1000,
	hitsPerPage: 1000,
	attributesToRetrieve: ["id", "name"].join(",")
	}
	const response = await fetch("https://proxy-algolia-prod.quixel.com/algolia/cache", {
	"headers": {
	"x-api-key": "2Zg8!d2WAHIUW?pCO28cVjfOt9seOWPx@2j"
	},
	"body": JSON.stringify({
	url: "https://6UJ1I5A072-2.algolianet.com/1/indexes/assets/query?x-algolia-application-id=6UJ1I5A072&x-algolia-api-key=e93907f4f65fb1d9f813957bdc344892",
	params: new URLSearchParams({ ...defaultParams, ...params }).toString()
	}),
	"method": "POST",
	})
	return await response.json()
	}

	const callAcl = async ({ id, name }) => {
	const response = await fetch("https://quixel.com/v1/acl", {
	"headers": {
	"authorization": "Bearer " + authToken,
	"content-type": "application/json;charset=UTF-8",
	},
	"body": JSON.stringify({ assetID: id }),
	"method": "POST",
	});
	const json = await response.json()
	if (json?.isError) {
	console.error(` --> UNABLE TO ADD ITEM Item ${id} \| ${name} (${json?.msg})`)
	} else {
	console.log(` --> ADDED ITEM Item ${id} \| ${name}`)
	}
	}

	const callAcquired = async () => {
	const response = await fetch("https://quixel.com/v1/assets/acquired", {
	"headers": {
	"authorization": "Bearer " + authToken,
	"content-type": "application/json;charset=UTF-8",
	},
	"method": "GET",
	});
	return await response.json()
	}

	// 1. Check token exist, quixel API needs it
	console.log("-> Checking Auth API Token...")
	let authToken = ""
	try {
	const authCookie = getCookie("auth") ?? "{}"
	authToken = JSON.parse(decodeURIComponent(authCookie))?.token
	if (!authToken) {
	return console.error("-> Error: cannot find authentication token. Please login again.")
	}
	} catch (_) {
	return console.error("-> Error: cannot find authentication token. Please login again.")
	}

	// 2. Get all currently acquired items
	console.log("-> Get Acquired Items...")
	const acquiredItems = (await callAcquired()).map(a => a.assetID)

	// 3. Get total count of items
	console.log("-> Getting Total Number of Pages....")
	const { nbPages: totalPages, hitsPerPage: itemsPerPage, nbHits: totalItems } = await callCacheApi()


	console.log("-> ==============================================")
	console.log(`-> Total # of items: ${totalItems}`)
	console.log(`-> ${totalPages} total pages with ${itemsPerPage} per page`)
	console.log(`-> Total Items to add: ${(totalItems - acquiredItems.length)}.`)
	console.log("-> ==============================================")

	if (!confirm(`Click OK to start adding ${(totalItems - acquiredItems.length)} items in your account.`)) return

	// Loop
	for (let pageIdx = startPage \|\| 0; pageIdx < totalPages; pageIdx++) {
	console.log(`-> ======================= PAGE ${pageIdx + 1}/${totalPages} START =======================`)

	console.log("-> Getting Items from page " + (pageIdx + 1) + " ...")

	const { hits: items } = await callCacheApi({ page: pageIdx })

	console.log("-> Adding non-acquired items...")

	// Filter out owned items
	const unownedItems = items.filter(i => !acquiredItems.includes(i.id))
	const aclPromises = unownedItems.map(callAcl)

	await Promise.all(aclPromises)
	console.log(`-> ======================= PAGE ${pageIdx + 1}/${totalPages} COMPLETED =======================`)
	if (autoClearConsole) console.clear() // Fix the issue that too much log hangs the console. Set autoClearConsole = false to keep the logs
	}

	console.log("-> Getting new acquired info...")
	// Get acquired items again
	const newItemsAcquired = (await callAcquired()).length
	const newTotalCount = (await callCacheApi()).nbHits

	console.log(`-> Completed. Your account now have a total of ${newItemsAcquired} out of ${newTotalCount} items.`)

	alert(`-> Your account now have a total of ${newItemsAcquired} out of ${newTotalCount} items.\n\nIf you find some items missing, try refresh the page and run the script again.`)
	})())